• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1
2Welcome to the libuv documentation
3==================================
4
5Overview
6--------
7
8libuv is a multi-platform support library with a focus on asynchronous I/O. It
9was primarily developed for use by `Node.js`_, but it's also used by `Luvit`_,
10`Julia`_, `uvloop`_, and `others`_.
11
12.. note::
13    In case you find errors in this documentation you can help by sending
14    `pull requests <https://github.com/libuv/libuv>`_!
15
16.. _Node.js: https://nodejs.org
17.. _Luvit: https://luvit.io
18.. _Julia: https://julialang.org
19.. _uvloop: https://github.com/MagicStack/uvloop
20.. _others: https://github.com/libuv/libuv/blob/v1.x/LINKS.md
21
22
23Features
24--------
25
26* Full-featured event loop backed by epoll, kqueue, IOCP, event ports.
27* Asynchronous TCP and UDP sockets
28* Asynchronous DNS resolution
29* Asynchronous file and file system operations
30* File system events
31* ANSI escape code controlled TTY
32* IPC with socket sharing, using Unix domain sockets or named pipes (Windows)
33* Child processes
34* Thread pool
35* Signal handling
36* High resolution clock
37* Threading and synchronization primitives
38
39
40Documentation
41-------------
42
43.. toctree::
44   :maxdepth: 1
45
46   design
47   api
48   guide
49   upgrading
50
51
52Downloads
53---------
54
55libuv can be downloaded from `here <https://dist.libuv.org/dist/>`_.
56
57
58Installation
59------------
60
61Installation instructions can be found in `the README <https://github.com/libuv/libuv/blob/master/README.md>`_.
62
63