aboutsummaryrefslogtreecommitdiff
path: root/docs/src
Commit message (Collapse)AuthorAge
...
* doc: fix typo in uv_thread_options_t definitionRyan Liptak2019-03-16
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/2195 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* doc: add note about uv_run() not being reentrantBen Noordhuis2019-03-08
| | | | | | | PR-URL: https://github.com/libuv/libuv/pull/2208 Refs: https://github.com/libuv/help/issues/81 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* doc: describe unix signal handling betterVladimír Čunát2019-02-11
| | | | | | | | | | | | | | - SIGTERM seems OK to handle - I tested that on Linux, read POSIX, etc. I can't see why it should be different from SIGUSR1, for example, except that the default handler is different. - Also raise(15) is caught by the handler for me, and I can't see why it wouldn't. The main source of knowledge for this is POSIX. http://pubs.opengroup.org/onlinepubs/9699919799/functions/V2_chap02.html#tag_15_04_03_03 PR-URL: https://github.com/libuv/libuv/pull/1987 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* thread: allow specifying stack size for new threadAnna Henningsen2019-02-08
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/2179 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* src,include: define UV_MAXHOSTNAMESIZEcjihrig2019-02-05
| | | | | | | | | | | | This commit adds UV_MAXHOSTNAMESIZE for working with uv_os_gethostname(). Prior to this commit, this logic was duplicated in several places across libuv and Node.js alone. PR-URL: https://github.com/libuv/libuv/pull/2175 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
* doc: fix uv_get_free_memory docStephen Belanger2019-02-05
| | | | | | | | | There was a formatting error that prevented the uv_get_free_memory function from appearing on the page. PR-URL: https://github.com/libuv/libuv/pull/2163 Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com> Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
* unix,win: add uv_os_uname()cjihrig2019-01-14
| | | | | | | | | Fixes: https://github.com/libuv/libuv/issues/2126 PR-URL: https://github.com/libuv/libuv/pull/2128 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
* Revert "win,fs: retry if uv_fs_rename fails"Ben Noordhuis2018-12-27
| | | | | | | | | | | | | This reverts commit e94c184c7c4a18f3de569c97caeb83f4ff98a4b2. Concerns were raised about the suitability of this policy and I, for one, agree with them. Fixes: https://github.com/libuv/libuv/issues/2098 PR-URL: https://github.com/libuv/libuv/pull/2122 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: clarify expected memory management strategyIvan Krylov2018-12-02
| | | | | | | | | | | Right now, docs don't make it clear when exactly does it become okay to free memory belonging to `uv_handle_t`. It's only stated that `uv_close` must be called before freeing the memory, which is a source of confusion for new users: they call `uv_close(handle, NULL)`, then free the memory (see e.g. #2078, https://stackoverflow.com/q/25615340). PR-URL: https://github.com/libuv/libuv/pull/2087 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* win: support more fine-grained windows hidingBartosz Sosnowski2018-11-10
| | | | | | | | | | | | Added UV_PROCESS_WINDOWS_HIDE_CONSOLE and UV_PROCESS_WINDOWS_HIDE_GUI for specifying if console or GUI subprocess windows are to be hidden. Refs: https://github.com/nodejs/node/pull/24034 PR-URL: https://github.com/libuv/libuv/pull/2073 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* win,fs: retry if uv_fs_rename failsBartosz Sosnowski2018-11-01
| | | | | | | | | | | On Windows rename operation can fail randomly in presence of antivirus or indexing software. Make `uv_fs_rename` retry up to four times with 250ms delay between attempts before giving up. PR-URL: https://github.com/libuv/libuv/pull/1981 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* win,doc: path encoding in uv_fs_XX is UTF-8hitesh2018-10-11
| | | | | | | | | Fixes: https://github.com/libuv/libuv/issues/1554 PR-URL: https://github.com/libuv/libuv/pull/1943 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* doc: remove extraneous "on"Ben Noordhuis2018-10-02
| | | | | | | | | Fixes: https://github.com/libuv/libuv/issues/2000 PR-URL: https://github.com/libuv/libuv/pull/2010 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jamie Davis <davisjam@vt.edu> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* stream: autodetect directionJameson Nash2018-09-19
| | | | | | | | | | | | | Previously, we required the user to specify the expected read/write flags for a pipe or tty. But we've already been asking the OS to tell us what they actually are (fcntl F_GETFL), so we can hopefully just use that information directly. Fixes: https://github.com/libuv/libuv/issues/1936 PR-URL: https://github.com/libuv/libuv/pull/1964 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* win,doc: improve uv_os_setpriority() documentationBartosz Sosnowski2018-09-18
| | | | | | | Refs: https://github.com/nodejs/node/pull/22817 PR-URL: https://github.com/libuv/libuv/pull/1985 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: clarify that some remarks apply to windowsBert Belder2018-09-18
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1988 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
* doc: fix argument name in tcp.rtsEmil Bay2018-09-03
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1974 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: add missing slash in stream.rstEmil Bay2018-09-01
| | | | | | | PR-URL: https://github.com/libuv/libuv/pull/1973 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* unix,win: add uv_os_{get,set}priority()cjihrig2018-08-15
| | | | | | | Refs: https://github.com/nodejs/node/pull/21675 PR-URL: https://github.com/libuv/libuv/pull/1945 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
* fs: add uv_open_osfhandleBartosz Sosnowski2018-08-09
| | | | | | | | | | Adds uv_open_osfhandle to complete uv_get_osfhandle Ref: https://github.com/nodejs/node/issues/15433 Ref: https://github.com/nodejs/node-addon-api/issues/304 PR-URL: https://github.com/libuv/libuv/pull/1927 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* fs: change position of uv_fs_lchownUjjwal Sharma2018-07-07
| | | | | | | | | | | | | | | | Change the position of UV_LS_LCHOWN, moving it to the end in order to go around a bug due to it's initial position. The original position of UV_LS_LCHOWN broke ABI compat, causing a binary using UV_FS_REALPATH or UV_FS_COPYFILE to break, as the values point to wrong function. Refs: https://github.com/yarnpkg/yarn/issues/6043 Fixes: https://github.com/libuv/libuv/issues/1908 PR-URL: https://github.com/libuv/libuv/pull/1913 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
* src: add new error apis to prevent memory leaksShelley Vohr2018-07-06
| | | | | | | | | | | | | | | | This PR creates two new externally-facing APIs, uv_err_name_r() and uv_strerror_r(). In keeping with the precedent set by POSIX, the *_r() suffix of these two new methods indicate that the caller does the memory management and passes in the memory that the output will be stored in, which provides an alternative for the two existent methods (uv_err_name() and uv_strerror()), which, when called with an unknown error code, leak a few bytes of memory. PR-URL: https://github.com/libuv/libuv/pull/1898 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Santiago Gimeno santiago.gimeno@gmail.com
* doc: document UV_*_MAP() macrosEd Schouten2018-06-19
| | | | | | | | | UV_ERRNO_MAP(), UV_HANDLE_TYPE_MAP(), and UV_REQ_TYPE_MAP() are considered part of the public API. This commit documents them. Fixes: https://github.com/libuv/libuv/issues/1607 PR-URL: https://github.com/libuv/libuv/pull/1653 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: undocument uv_req_type's UV_REQ_TYPE_PRIVATEEd Schouten2018-06-19
| | | | | | | | | | This is merely an internal definition that may expand to OS specific request types. It is not an actual symbolic constant part of the enumeration. Fixes: https://github.com/libuv/libuv/issues/1607 PR-URL: https://github.com/libuv/libuv/pull/1653 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* 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>