mirror of https://github.com/lukechilds/node.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
85 lines
1.7 KiB
85 lines
1.7 KiB
11 years ago
|
|
||
|
|
Welcome to the libuv API documentation
|
||
|
|
======================================
|
||
|
|
|
||
|
|
Overview
|
||
|
|
--------
|
||
|
|
|
||
|
|
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 Mozilla's
|
||
|
|
`Rust language`_, `Luvit`_, `Julia`_, `pyuv`_, and `others`_.
|
||
|
|
|
||
|
|
.. note::
|
||
|
|
In case you find errors in this documentation you can help by sending
|
||
|
|
`pull requests <https://github.com/joyent/libuv>`_!
|
||
|
|
|
||
|
|
.. _Node.js: http://nodejs.org
|
||
|
|
.. _Rust language: http://www.rust-lang.org
|
||
|
|
.. _Luvit: http://luvit.io
|
||
|
|
.. _Julia: http://julialang.org
|
||
|
|
.. _pyuv: https://github.com/saghul/pyuv
|
||
|
|
.. _others: https://github.com/joyent/libuv/wiki/Projects-that-use-libuv
|
||
|
|
|
||
|
|
|
||
|
|
Features
|
||
|
|
--------
|
||
|
|
|
||
|
|
* 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
|
||
|
|
|
||
|
|
|
||
|
|
Downloads
|
||
|
|
---------
|
||
|
|
|
||
|
|
libuv can be downloaded from `here <http://dist.libuv.org/dist/>`_.
|
||
|
|
|
||
|
|
|
||
|
|
Installation
|
||
|
|
------------
|
||
|
|
|
||
|
|
Installation instructions can be found on `the README <https://github.com/joyent/libuv/blob/master/README.md>`_.
|
||
|
|
|
||
|
|
|
||
|
|
Documentation
|
||
|
|
-------------
|
||
|
|
|
||
|
|
.. toctree::
|
||
|
|
:maxdepth: 1
|
||
|
|
|
||
|
|
design
|
||
|
|
errors
|
||
|
|
loop
|
||
|
|
handle
|
||
|
|
request
|
||
|
|
timer
|
||
|
|
prepare
|
||
|
|
check
|
||
|
|
idle
|
||
|
|
async
|
||
|
|
poll
|
||
|
|
signal
|
||
|
|
process
|
||
|
|
stream
|
||
|
|
tcp
|
||
|
|
pipe
|
||
|
|
tty
|
||
|
|
udp
|
||
|
|
fs_event
|
||
|
|
fs_poll
|
||
|
|
fs
|
||
|
|
threadpool
|
||
|
|
dns
|
||
|
|
dll
|
||
|
|
threading
|
||
|
|
misc
|