aboutsummaryrefslogtreecommitdiff
path: root/docs/src
Commit message (Collapse)AuthorAge
...
* doc: document uv_pipe_t::ipcEd Schouten2018-06-19
| | | | | | Fixes: https://github.com/libuv/libuv/issues/1607 PR-URL: https://github.com/libuv/libuv/pull/1653 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* unix,win: add uv_fs_lchown()Paolo Greppi2018-06-19
| | | | | | Fixes: https://github.com/libuv/libuv/issues/1790 PR-URL: https://github.com/libuv/libuv/pull/1826 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: add uv_fs_fsync() AIX limitationsJohn Barboza2018-06-19
| | | | | | | | | | Unlike other platforms, the fsync call on aix will not accept non-regular file file-descriptors. Refs: https://github.com/nodejs/node/pull/21298 PR-URL: https://github.com/libuv/libuv/pull/1879 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
* core: move all include files except uv.h to uv/Saúl Ibarra Corretgé2018-06-14
| | | | | | | | | | | | | | This is a cherry-pick of commit d010030ad5 from the master branch. Conflicts: Makefile.am include/uv.h include/uv/unix.h libuv.nsi (deleted) src/unix/pthread-barrier.c (deleted) PR-URL: https://github.com/libuv/libuv/pull/1850 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* win,process: allow child pipe handles to be opened in overlapped modeBjörn Linse2018-05-25
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1784 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Bert Belder <bertbelder@gmail.com>
* doc: clarify platform specific pipe namingThomas Versteeg2018-04-07
| | | | | | | | | Pipe naming conventions differ on Windows and Unix. This commit calls out the naming conventions and requirements. PR-URL: https://github.com/libuv/libuv/pull/1765 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
* doc,fs: improve documentationBob Burger2018-04-06
| | | | | | | | | | Update description of `uv_fs_readlink` and `uv_fs_realpath` to describe where the resulting string goes. Fixes: https://github.com/libuv/libuv/issues/1771 PR_URL: https://github.com/libuv/libuv/pull/1786 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* unix,win: add UV_FS_COPYFILE_FICLONE_FORCE supportcjihrig2018-03-16
| | | | | | | | | | | UV_FS_COPYFILE_FICLONE_FORCE attempts to use copy-on-write semantics in uv_fs_copyfile(). If CoW is not available, an error is returned. Refs: https://github.com/libuv/libuv/pull/1465 Refs: https://github.com/libuv/libuv/pull/1491 PR-URL: https://github.com/libuv/libuv/pull/1768 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* unix: add UV_FS_COPYFILE_FICLONE supportcjihrig2018-03-05
| | | | | | | | | | | UV_FS_COPYFILE_FICLONE attemps to use copy-on-write semantics in uv_fs_copyfile(). If CoW is not available, it falls back to a normal copy operation. Refs: https://github.com/libuv/libuv/pull/1465 PR-URL: https://github.com/libuv/libuv/pull/1491 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: fix syntax error in loop documentationBartosz Sosnowski2018-02-21
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1748 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: add note about handle movabilityBartosz Sosnowski2018-02-21
| | | | | | | | | | Add note that explaining pointers to handles need to remain valid during the requested operations. Refs: https://github.com/libuv/libuv/issues/1731 PR-URL: https://github.com/libuv/libuv/pull/1749 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: document uv_timer_start() on an active timerVladimír Čunát2018-02-21
| | | | | | | | Fixes: https://github.com/libuv/libuv/issues/1401 PR-URL: https://github.com/libuv/libuv/pull/1538 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* zos: fix timeout for condition variableJohn Barboza2018-02-15
| | | | | | | | | | The pthread_cond_timedwait requires a timeout relative to the Epoch. So don't use uv__hrtime to set the timeout because it is relative to an arbitrary time in the past. Use gettimeofday instead. PR-URL: https://github.com/libuv/libuv/pull/1711 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Jamie Davis <davisjam@vt.edu>
* win: map 0.0.0.0 and :: addresses to localhostBartosz Sosnowski2017-12-28
| | | | | | | | On Linux when connecting IP addresses 0.0.0.0 and :: are automatically converted to localhost. This adds same functionality to Windows. PR-URL: https://github.com/libuv/libuv/pull/1515 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* zos: implement uv_fs_event* functionsJohn Barboza2017-12-15
| | | | | | | | | | | | | | | | This commit uses the Register File Interest feature on z/OS to enable users to monitor file system events. The poll call is used to check for file descriptors as well as a message queue that z/OS will report file system events on. The last item on the list used by poll will contain the message queue id instead of a file descriptor. Limitation: Writes to a directory (that is, file creation and deletion) do not generate a change message for a registered directory. PR-URL: https://github.com/libuv/libuv/pull/1311 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* unix: make get(set)_process_title MT-safeMatt Harrison2017-12-02
| | | | | | | | | | | Used a shared uv_mutex_t in unix implementations of these functions to prevent simultaneous execution. Fixes: https://github.com/libuv/libuv/issues/271 PR-URL: https://github.com/libuv/libuv/pull/1640 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* core: add getter/setter functions for easier ABI compatAnna Henningsen2017-12-02
| | | | | | | | | | | | | | | | | | | | | Add getter/setter functions for the fields of public structs that might be relevant to e.g. Node.js addons. Through these methods, ABI compatibility for a subset of the ABI is easier to achieve, since using them makes code independent of the exact offsets of these fields. The intended use case that prompted this are N-API addons for Node.js, which look for more long-term ABI compatibility guarantees than typical Node code. With these helper functions, using libuv directly should no longer be an obstacle for such addons. PR-URL: https://github.com/libuv/libuv/pull/1657 Refs: https://github.com/nodejs/node/issues/13512 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* unix,win: add uv_os_getpid()Bartosz Sosnowski2017-11-30
| | | | | | | Adds a multi platform way to get current process id. PR-URL: https://github.com/libuv/libuv/pull/1661 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: remove note about SIGWINCH on WindowsBartosz Sosnowski2017-11-28
| | | | | | | | | SIGWINCH support was improved by https://github.com/libuv/libuv/commit/6ad1e81547c83f9fe7c5a806b6b282642e8d3bca PR-URL: https://github.com/libuv/libuv/pull/1638 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* win: map UV_FS_O_EXLOCK to a share mode of 0Joran Dirk Greef2017-11-16
| | | | | | | | This is necessary to enable writing past the MBR of a raw block device. Fixes: https://github.com/libuv/libuv/issues/1605 PR-URL: https://github.com/libuv/libuv/pull/1613 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
* doc: clarify the description of uv_loop_alive()Ed Schouten2017-11-15
| | | | | | | | | | | | This function not only returns true if there are active handles or requests. First of all, it also takes into account whether handles are referenced. Second, handles that are being closed also contribute to whether a loop is alive. Fixes: https://github.com/libuv/libuv/issues/1592 PR-URL: https://github.com/libuv/libuv/pull/1594 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* unix,win: add uv_if_{indextoname,indextoiid}Pekka Nikander2017-11-06
| | | | | | | | | | | | | | | uv_if_indextoname() is used to convert an IPv6 scope_id to an interface identifier string such as %eth0 or %lo. uv_if_indextoiid() returns an IPv6 interface identifier. On Unix it calls uv_if_indextoname(). On Windows it uses snprintf() to return the numeric interface identifier as a string. Refs: https://github.com/nodejs/node/pull/14500 PR-URL: https://github.com/libuv/libuv/pull/1445 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* pipe: allow access from other usersBartosz Sosnowski2017-11-06
| | | | | | | | | Adds new uv_pipe_chmod function which can be used to make the pipe writable or readable by all users. PR-URL: https://github.com/libuv/libuv/pull/1386 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: mark uv_default_loop() as not thread saferayrase2017-11-01
| | | | | | Fixes: https://github.com/libuv/libuv/issues/1461 PR-URL: https://github.com/libuv/libuv/pull/1590 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* unix,win: add uv_os_getppid()cjihrig2017-11-01
| | | | | | | | Refs: https://github.com/nodejs/node/issues/14957 PR-URL: https://github.com/libuv/libuv/pull/1610 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
* unix,win: add fs open flags, map O_DIRECT|O_DSYNCJoran Dirk Greef2017-10-03
| | | | | | | | | | | | Define stable cross-platform file open constants so that users can pass `UV_FS_O_RDWR` rather than `_O_RDWR` (win) or `O_RDWR` (unix). Map `UV_FS_O_DIRECT`, `UV_FS_O_DSYNC` and `UV_FS_O_SYNC` to `FILE_FLAG_NO_BUFFERING` and `FILE_FLAG_WRITE_THROUGH` (win). Fixes: https://github.com/libuv/libuv/issues/1550 PR-URL: https://github.com/libuv/libuv/pull/1567 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
* unix,win: add uv_mutex_init_recursive()Scott Parker2017-10-02
| | | | | | | | | | | Support the creation of recursive mutexes on Unix. A matching API is added on Windows, however mutexes on Windows are always recursive. Refs: https://github.com/libuv/libuv/issues/1022 PR-URL: https://github.com/libuv/libuv/pull/1555 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: fix a trivial typoVladimír Čunát2017-09-01
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1516 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* unix, windows: add basic uv_fs_copyfile()cjihrig2017-08-15
| | | | | | | | | Fixes: https://github.com/libuv/libuv/issues/925 PR-URL: https://github.com/libuv/libuv/pull/1465 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* doc: document uv_async_(init|send) return valuesBen Noordhuis2017-07-27
| | | | | | | Fixes: https://github.com/libuv/libuv/issues/576 PR-URL: https://github.com/libuv/libuv/pull/1435 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* docs: fix guide source code example pathsAnticrisis2017-07-25
| | | | | | | | | Source code examples in the User guide were not appearing in the built documentation because the relative paths were incorrect. PR-URL: https://github.com/libuv/libuv/pull/1428 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* poll: add support for OOB TCP and GPIO interruptsCurlyMoo2017-07-12
| | | | | | | | | | | | | | | Out-of-band TCP messages are used for TCP data transmission outside (outband) the inbound TCP data. These packets are sent with an "urgent pointer", but previously discarded. Additionally, when using (e)poll a POLLPRI is triggered when an interrupt signal is received on GPIO capable systems such as the Raspberry Pi. PR-URL: https://github.com/libuv/libuv/pull/1040 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* doc: add thread safety warning for process titleMatthew Taylor2017-07-12
| | | | | | | | | | | | | Add a small warning about uv_get_process_title() and uv_set_process_title() not being thread safe on platforms other than Windows. Also add a reminder for users to call uv_setup_args() first. Fixes: https://github.com/libuv/libuv/issues/1395 PR-URL: https://github.com/libuv/libuv/pull/1396 Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* win: make uv__get_osfhandle() publicJuan Cruz Viotti2017-05-30
| | | | | | | | | | | | | | | | | | | | The uv__get_osfhandle() function is a private functio of the Windows subsystem, and its used to get a Windows HANDLE out of a file descriptor number. The motivation behind making this function public is to allow Node.js programs to pass file descriptors created using fs.open() to native Node.js C++ add-ons, and be able to successfully convert them to Windows HANDLEs. Refs: https://github.com/libuv/libuv/pull/1166 Refs: https://github.com/nodejs/node/issues/6369 Fixes: https://github.com/libuv/libuv/issues/1291 PR-URL: https://github.com/libuv/libuv/pull/1323 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: mark uv_loop_fork() as experimentalcjihrig2017-05-25
| | | | | | | | | | | | | uv_loop_fork() was recently added, but is known to contain bugs. This commit marks the function as experimental so that bugs can be addressed without blocking further libuv releases. Refs: https://github.com/libuv/libuv/pull/846 Refs: https://github.com/libuv/libuv/pull/1269 Refs: https://github.com/libuv/libuv/issues/1264 PR-URL: https://github.com/libuv/libuv/pull/1356 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* unix,win: add uv_os_gethostname()cjihrig2017-05-18
| | | | | | | Fixes: https://github.com/libuv/libuv/issues/1315 PR-URL: https://github.com/libuv/libuv/pull/1342 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
* doc: add warning note to user guideSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: remove licensing note from guide/aboutSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: update guide/about and mention new maintainershipSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: removed unused fileSaúl Ibarra Corretgé2017-04-28
| | | | | | | | We use guide.rst as our index, so there is no need for a secondary one. PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: add initial version of the User GuideSaúl Ibarra Corretgé2017-04-28
| | | | | | | | | This is a fresh import of uvbook [0], as is. It is to be considered "beta", as the entire content hasn't been revised / adapted yet. PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: move "upgrading" to a standalone documentSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: move documentation section upSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: move TOC to a dedicated documentSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: update copyright yearsSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: rename docs to "libuv documentation"Saúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: fix documentation for uv_handle_t.typeDaniel Kahn Gillmor2017-04-25
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1316 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* doc: libuv does not touch uv_loop_t.dataBen Noordhuis2017-04-18
| | | | | | | | | Mea culpa, I forgot to update the documentation in commit ff0ae10 ("unix: preserve loop->data across loop init/done") from July 2016. PR-URL: https://github.com/libuv/libuv/pull/1299 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: suggestions for design pageDaniel Bevenius2017-04-12
| | | | | | | | | | While reading the design page I came across a few sentences that could perhaps be improved, and this commit contains suggestions for such improvements. PR-URL: https://github.com/libuv/libuv/pull/1302 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: minor grammar fix in Installation sectionDaniel Bevenius2017-04-11
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1301 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>