mirror of
https://github.com/ilyakooo0/urbit.git
synced 2024-12-18 20:31:40 +03:00
147 lines
4.0 KiB
Markdown
147 lines
4.0 KiB
Markdown
![libuv][libuv_banner]
|
|
|
|
## Overview
|
|
|
|
libuv is a multi-platform support library with a focus on asynchronous I/O. It
|
|
was primarily developed for use by [Node.js](http://nodejs.org), but it's also
|
|
used by Mozilla's [Rust language](http://www.rust-lang.org/),
|
|
[Luvit](http://luvit.io/), [Julia](http://julialang.org/),
|
|
[pyuv](https://github.com/saghul/pyuv), and [others](https://github.com/joyent/libuv/wiki/Projects-that-use-libuv).
|
|
|
|
## Feature highlights
|
|
|
|
* 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
|
|
|
|
|
|
## Community
|
|
|
|
* [Mailing list](http://groups.google.com/group/libuv)
|
|
|
|
## Documentation
|
|
|
|
* [include/uv.h](https://github.com/joyent/libuv/blob/master/include/uv.h)
|
|
— API documentation in the form of detailed header comments.
|
|
* [An Introduction to libuv](http://nikhilm.github.com/uvbook/)
|
|
— An overview of libuv with tutorials.
|
|
* [LXJS 2012 talk](http://www.youtube.com/watch?v=nGn60vDSxQ4)
|
|
— High-level introductory talk about libuv.
|
|
* [Tests and benchmarks](https://github.com/joyent/libuv/tree/master/test)
|
|
— API specification and usage examples.
|
|
* [libuv-dox](https://github.com/thlorenz/libuv-dox)
|
|
— Documenting types and methods of libuv, mostly by reading uv.h.
|
|
|
|
## Build Instructions
|
|
|
|
For GCC there are two methods building: 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:
|
|
|
|
$ sh autogen.sh
|
|
$ ./configure
|
|
$ make
|
|
$ make check
|
|
$ make install
|
|
|
|
### Windows
|
|
|
|
First, [Python][] 2.6 or 2.7 must be installed as it is required by [GYP][].
|
|
If python is not in your path set the environment variable `PYTHON` to its
|
|
location. For example: `set PYTHON=C:\Python27\python.exe`
|
|
|
|
To build with Visual Studio, launch a git shell (e.g. Cmd or PowerShell)
|
|
and run vcbuild.bat which will checkout the GYP code into build/gyp and
|
|
generate uv.sln as well as related project files.
|
|
|
|
To have GYP generate build script for another system, checkout GYP into the
|
|
project tree manually:
|
|
|
|
$ mkdir -p build
|
|
$ git clone https://git.chromium.org/external/gyp.git build/gyp
|
|
|
|
### Unix
|
|
|
|
Run:
|
|
|
|
$ ./gyp_uv.py -f make
|
|
$ make -C out
|
|
|
|
### OS X
|
|
|
|
Run:
|
|
|
|
$ ./gyp_uv.py -f xcode
|
|
$ xcodebuild -ARCHS="x86_64" -project uv.xcodeproj \
|
|
-configuration Release -target All
|
|
|
|
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").
|
|
|
|
### Android
|
|
|
|
Run:
|
|
|
|
$ source ./android-configure NDK_PATH gyp
|
|
$ make -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.
|
|
|
|
### Running tests
|
|
|
|
Run:
|
|
|
|
$ ./gyp_uv.py -f make
|
|
$ make -C out
|
|
$ ./out/Debug/run-tests
|
|
|
|
## Supported Platforms
|
|
|
|
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 using the GCC toolchain.
|
|
|
|
OS X using the GCC or XCode toolchain.
|
|
|
|
Solaris 121 and later using GCC toolchain.
|
|
|
|
## Patches
|
|
|
|
See the [guidelines for contributing][].
|
|
|
|
[node.js]: http://nodejs.org/
|
|
[GYP]: http://code.google.com/p/gyp/
|
|
[Python]: https://www.python.org/downloads/
|
|
[Visual Studio Express 2010]: http://www.microsoft.com/visualstudio/eng/products/visual-studio-2010-express
|
|
[guidelines for contributing]: https://github.com/joyent/libuv/blob/master/CONTRIBUTING.md
|
|
[libuv_banner]: https://raw.githubusercontent.com/joyent/libuv/master/img/banner.png
|