Repository files navigation

Documenting types and methods oflibuv, mostly by readinguv.h.

The information found inuv.h has been organized into three categories:

• types
• callbacks
• methods

Examples were added to show how the API is used.

The inheritance relationship is documented via:, i.e.uv_tcp_t : uv_stream_t denotes thatuv_tcp_tderives fromuv_stream_t and thus has all the stream type fields.

Macros of extra/private fields have been resolved as much as was sensible and the original location and name is documented,i.e. the private fields foruv_fs_t found insideinclude/uv-unix.h are included.

Note:uv-unix.h was always preferred overuv-win.h when resolving fields from macros.

Although they are techniqually types as well they are documented in a separately in order to speed up lookup.

The methods are categorized and ordered to mirror the categorization and order of the types that they use.

The libuv version at that is the source of this documentation is:v0.11.17.

MIT