libuv is a new platform layer for Node. Its purpose is to abstract IOCP on Windows and epoll/kqueue/event ports/etc. on Unix systems. We intend to eventually contain all platform differences in this library.
Non-blocking TCP sockets
Non-blocking named pipes
Child process spawning
Asynchronous DNS via
Asynchronous file system APIs
High resolution time
Current executable path look up
Thread pool scheduling
ANSI escape code controlled TTY
File system events Currently supports inotify,
ReadDirectoryChangesWand kqueue. Event ports in the near future.
IPC and socket sharing between processes
- include/uv.h — API documentation in the form of detailed header comments.
- An Introduction to libuv — An overview of libuv with tutorials.
- LXJS 2012 talk - High-level introductory talk about libuv.
- Tests and benchmarks - API specification and usage examples.
For GCC (including MinGW) there are two methods building: via normal makefiles or via GYP. GYP is a meta-build system which can generate MSVS, Makefile, and XCode backends. It is best used for integration into other projects. The old system is using plain GNU Makefiles.
To build via Makefile simply execute:
MinGW users should run this instead:
Out-of-tree builds are supported:
To build a shared object:
make libuv.so # libuv.dylib on OS X
To build with Visual Studio run the vcbuild.bat file which will checkout the GYP code into build/gyp and generate the uv.sln and related files.
Windows users can also build from cmd-line using msbuild. This is done by running vcbuild.bat from Visual Studio command prompt.
To have GYP generate build script for another system, make sure that you have Python 2.6 or 2.7 installed, then checkout GYP into the project tree manually:
mkdir -p build svn co http://gyp.googlecode.com/svn/trunk build/gyp
mkdir -p build git clone https://git.chromium.org/external/gyp.git build/gyp
Unix users run
./gyp_uv -f make make -C out
Macintosh users run
./gyp_uv -f xcode xcodebuild -project uv.xcodeproj -configuration Release -target All
Note for UNIX users: compile your project with
-D_FILE_OFFSET_BITS=64. GYP builds take care of that automatically.
Note for Linux users: compile your project with
-D_GNU_SOURCE when you
uv.h. GYP builds take care of that automatically. If you use
autotools, add a
AC_GNU_SOURCE declaration to your
To build for android, locate your android NDK path, then run:
source ./android-configure NDK_PATH make
To build for android with gyp, add "gyp" to the configuration:
source ./android-configure NDK_PATH gyp make -C out
Microsoft Windows operating systems since Windows XP SP2. It can be built with either Visual Studio or MinGW. Consider using Visual Studio Express 2010 or later if you do not have a full Visual Studio license.
Linux 2.6 using the GCC toolchain.
MacOS using the GCC or XCode toolchain.
Solaris 121 and later using GCC toolchain.