Name: libuv
Owner: libuv
Description: Cross-platform asynchronous I/O
Created: 2013-11-30 00:29:56.0
Updated: 2018-01-18 23:39:58.0
Pushed: 2018-01-19 00:28:12.0
Homepage: http://libuv.org/
Size: 12502
Language: C
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
libuv is a multi-platform support library with a focus on asynchronous I/O. It was primarily developed for use by Node.js, but it's also used by Luvit, Julia, pyuv, and others.
Full-featured event loop backed by epoll, kqueue, IOCP, event ports.
Asynchronous TCP and UDP sockets
Asynchronous DNS resolution
Asynchronous file and file system operations
File system events
ANSI escape code controlled TTY
IPC with socket sharing, using Unix domain sockets or named pipes (Windows)
Child processes
Thread pool
Signal handling
High resolution clock
Threading and synchronization primitives
Starting with version 1.0.0 libuv follows the semantic versioning scheme. The API change and backwards compatibility rules are those indicated by SemVer. libuv will keep a stable ABI across major releases.
The ABI/API changes can be tracked here.
libuv is licensed under the MIT license. Check the LICENSE file. The documentation is licensed under the CC BY 4.0 license. Check the LICENSE-docs file.
Located in the docs/ subdirectory. It uses the Sphinx framework, which makes it possible to build the documentation in multiple formats.
Show different supported building options:
ke help
Build documentation as HTML:
ke html
Build documentation as HTML and live reload it when it changes (this requires sphinx-autobuild to be installed and is only supported on Unix):
ke livehtml
Build documentation as man pages:
ke man
Build documentation as ePub:
ke epub
NOTE: Windows users need to use make.bat instead of plain 'make'.
Documentation can be browsed online here.
The tests and benchmarks also serve as API specification and usage examples.
These resources are not handled by libuv maintainers and might be out of date. Please verify it before opening new issues.
libuv can be downloaded either from the GitHub repository or from the downloads site.
Starting with libuv 1.7.0, binaries for Windows are also provided. This is to be considered EXPERIMENTAL.
Before verifying the git tags or signature files, importing the relevant keys is necessary. Key IDs are listed in the MAINTAINERS file, but are also available as git blob objects for easier use.
Importing a key the usual way:
g --keyserver pool.sks-keyservers.net --recv-keys AE9BC059
Importing a key from a git blob object:
t show pubkey-saghul | gpg --import
Git tags are signed with the developer's key, they can be verified as follows:
t verify-tag v1.6.1
Starting with libuv 1.7.0, the tarballs stored in the downloads site are signed and an accompanying signature file sit alongside each. Once both the release tarball and the signature file are downloaded, the file can be verified as follows:
g --verify libuv-1.7.0.tar.gz.sign
For GCC there are two build methods: via autotools 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.
To build with autotools:
autogen.sh
configure
ke
ke check
ke install
Prerequisites:
PYTHON to its
location. For example: set PYTHON=C:\Python27\python.exePATH.To build, launch a git shell (e.g. Cmd or PowerShell), run vcbuild.bat
(to build with VS2017 you need to explicitly add a vs2017 argument),
which will checkout the GYP code into build/gyp, generate uv.sln
as well as the necesery related project files, and start building.
build
Or:
build vs2017
To run the tests:
build test
To see all the options that could passed to vcbuild:
build help
ild.bat [debug/release] [test/bench] [clean] [noprojgen] [nobuild] [vs2017] [x86/x64] [static/shared]
ples:
build.bat : builds debug build
build.bat test : builds debug build and runs tests
build.bat release bench: builds release build and runs benchmarks
For Debug builds (recommended) run:
gyp_uv.py -f make
ke -C out
For Release builds run:
gyp_uv.py -f make
ILDTYPE=Release make -C out
Run ./gyp_uv.py -f make -Dtarget_arch=x32 to build x32 binaries.
Run:
gyp_uv.py -f xcode
odebuild -ARCHS="x86_64" -project uv.xcodeproj \
-configuration Release -target All
Using Homebrew:
ew install --HEAD libuv
Note to OS X users:
Make sure that you specify the architecture you wish to build for in the “ARCHS” flag. You can specify more than one by delimiting with a space (e.g. “x86_64 i386”).
Run:
urce ./android-configure NDK_PATH gyp [API_LEVEL]
ke -C out
The default API level is 24, but a different one can be selected as follows:
urce ./android-configure ~/android-ndk-r15b gyp 21
ke -C out
Note for UNIX users: compile your project with -D_LARGEFILE_SOURCE and
-D_FILE_OFFSET_BITS=64. GYP builds take care of that automatically.
To use ninja for build on ninja supported platforms, run:
gyp_uv.py -f ninja
nja -C out/Debug #for debug build OR
nja -C out/Release
Run:
gyp_uv.py -f make
ke -C out
out/Debug/run-tests
Check the SUPPORTED_PLATFORMS file.
AIX support for filesystem events requires the non-default IBM bos.ahafs
package to be installed. This package provides the AIX Event Infrastructure
that is detected by autoconf.
IBM documentation
describes the package in more detail.
AIX support for filesystem events is not compiled when building with gyp.
See the guidelines for contributing.