aboutsummaryrefslogtreecommitdiff
path: root/docs/src
Commit message (Collapse)AuthorAge
* doc: add entries for extended getpwJuan José Arboleda2024-05-28
| | | | | | | | | This patch adds documentation for the introduced `uv_os_get_passwd2`, `uv_os_get_group`, `uv_os_free_group` methods in https://github.com/libuv/libuv/pull/3523 Fixes: https://github.com/libuv/libuv/issues/4007 Signed-off-by: Juan José Arboleda <soyjuanarbol@gmail.com>
* unix: support SO_REUSEPORT with load balancing for TCPAndy Pan2024-05-21
|
* doc: fix some typosjosedelinux2024-04-26
|
* doc: correct udp socket options documentation (#4371)Ben Noordhuis2024-03-25
| | | | | | | uv_udp_init() creates the UDP socket lazily but to set socket options there must be, well, a socket to set the options on. Document how and when that requirement is met. Fixes: https://github.com/libuv/libuv/issues/4370
* unix,win: error on zero delay tcp keepaliveSaúl Ibarra Corretgé2024-03-22
| | | | Closes: https://github.com/libuv/libuv/pull/4350 Closes: https://github.com/libuv/libuv/issues/3487
* win/spawn: optionally run executable paths with no file extension (#4292)Brad King2024-02-05
| | | | | | | Add a process options flag to enable the optional behavior. Most users are likely recommended to set this flag by default, but it was deemed potentially breaking to set it by default in libuv. Co-authored-by: Kyle Edwards <kyle.edwards@kitware.com>
* unix,win: utility for setting priority for thread (#4075)Hao Hu2023-11-14
| | | | | | | | | Add uv_thread_setpriority for setting priority for threads created by uv_thread_create. Add uv_thread_getpriority for getting thread priority. For Linux by default, if the scheduling policy is SCHED_OTHER and the priority is 0, we need to set the nice value. Fixes: https://github.com/libuv/libuv/issues/4051
* misc: export WTF8 conversion utilities (#4021)Jameson Nash2023-10-28
| | | | | | | | | As promised in #2970, this attempts to migrate code to a common set of utilities in a common place in the code and use them everywhere. This also exports the functionality, since the Windows API with WideCharToMultiByte is fairly verbose relative to what libuv and libuv's clients typically need, so it is useful not to require clients to reimplement this conversion logic unnecessarily (and because Windows is not 64-bit ready here, but this implementation is.)
* doc: filename arg to uv_fs_event_cb can be NULL (#4177)Ben Noordhuis2023-10-22
| | | Refs: https://github.com/libuv/libuv/issues/4160
* doc: uv_close should be called after exit callback (#4164)Pleuvens2023-10-14
| | | Fixes: https://github.com/libuv/libuv/issues/1911
* doc: fix broken "Shared library" Wikipedia link (#4128)Alois Klink2023-08-28
| | | | | | | `linkcheck` is printing the following error: ``` ( guide/utilities: line 311) broken https://en.wikipedia.org/wiki/Shared_library#Shared_libraries - Anchor 'Shared_libraries' not found ```
* doc: switch to Furo, a more modern Sphinx theme (#4094)Saúl Ibarra Corretgé2023-08-14
|
* include: add EUNATCH errno mapping (#4047)Abdirahim Musse2023-06-16
| | | add EUNATCH errno mapping
* unix,win: add UV_PIPE_NO_TRUNCATE flag (#4040)Ben Noordhuis2023-06-06
| | | | | | Libuv's default behavior is to truncate long Unix socket paths. The flag tells it to return an error instead. Fixes: https://github.com/libuv/libuv/issues/4036
* linux: support abstract unix sockets (#4030)Ben Noordhuis2023-06-04
| | | | | Add two new APIs for binding and connecting to abstract UNIX sockets. Fixes: https://github.com/libuv/libuv/issues/4028
* unix: constrained_memory should return UINT64_MAX (#3753)Tim Besard2023-05-12
| | | | | | | | | | | Document that we return UINT64_MAX if the cgroup limit is set to the max. For cgroupv2, that happens if we encounter `max`, while cgroupv1 returns 9223372036854771712 when no limit is set (which according to [this StackExchange discussion] is derived from LONG_MAX and PAGE_SIZE). So make sure we also detect this case for cgroupv1. [this StackExchange discussion]: https://unix.stackexchange.com/questions/420906/what-is-the-value-for-the-cgroups-limit-in-bytes-if-the-memory-is-not-restricte Addresses: https://github.com/libuv/libuv/pull/3744/files#r974062912
* docs: fix some typos (#3984)cui fliter2023-05-12
|
* unix,win: add uv_clock_gettime() (#3971)Ben Noordhuis2023-04-27
| | | Fixes: https://github.com/libuv/libuv/issues/1674
* linux: introduce io_uring support (#3952)Ben Noordhuis2023-04-18
| | | | | | | | | | | | | | | | Add io_uring support for several asynchronous file operations: - read, write - fsync, fdatasync - stat, fstat, lstat io_uring is used when the kernel is new enough, otherwise libuv simply falls back to the thread pool. Performance looks great; an 8x increase in throughput has been observed. This work was sponsored by ISC, the Internet Systems Consortium. Fixes: https://github.com/libuv/libuv/issues/1947
* doc: consistent single backquote in misc.rst (#3946)Jason Zhang2023-04-11
| | | Fixes: https://github.com/libuv/libuv/issues/3928
* win,unix: change execution order of timers (#3927)Trevor Norris2023-03-20
| | | | | | | | | | | | | | | | | | | | | | | | The maximum number of times timers should run when uv_run() is called with UV_RUN_ONCE and UV_RUN_NOWAIT is 1. Do that by conditionally calling timers before entering the while loop when called with UV_RUN_DEFAULT. The reason to always run timers at the end of the while loop, instead of at the beginning, is to help enforce the conceptual event loop model. Which starts when entering the event provider (e.g. calling poll). Other than only allowing timers to be processed once per uv_run() execution, the only other noticeable change this will show is if all the following are true: * uv_run() is called with UV_RUN_NOWAIT or UV_RUN_ONCE. * An event is waiting to be received when poll is called. * Execution time between the call to uv_timer_start() and entering the while loop is longer than the timeout. If all these are true, then timers that would have executed before entering the event provider will now be executed afterward. Fixes: https://github.com/libuv/libuv/issues/3686 Co-authored-by: Momtchil Momtchev <momtchil@momtchev.com>
* doc: document uv_fs_cb type (#3517)Tamás Bálint Misius2023-01-19
|
* unix,win: add uv_get_available_memory() (#3754)Tim Besard2022-11-24
|
* thread: add uv_thread_getcpu() (#3803)daomingq2022-11-15
| | | | Add uv_thread_getcpu() api to get the cpu number on which the calling thread is running.
* src: add new metrics APIs (#3749)Trevor Norris2022-11-11
| | | | | | | | | | | | | The following metrics are now always recorded and available via the new uv_metrics_info() API. * loop_count: Number of event loop iterations. * events: Total number of events processed by the event handler. * events_waiting: Total number of events waiting in the event queue when the event provider request was made. Benchmarking has shown no noticeable impact recording these metrics. PR-URL: https://github.com/libuv/libuv/pull/3749
* doc: document 0 return value for free/total memory (#3817)Ben Noordhuis2022-11-08
| | | Refs: https://github.com/libuv/libuv/discussions/3809
* doc: mention close_cb can be NULL (#3810)Qix2022-11-08
|
* win: drop code checking for Windows XP / Server 2k3Saúl Ibarra Corretgé2022-11-08
| | | | Our minimum requirements are Windows 8 now.
* thread: add support for affinity (#3774)daomingq2022-10-21
| | | | | | | | Backported thread affinity feature and related dependency commits from master. It will add support for those APIs: uv_cpumask_size, uv_thread_setaffinity, uv_thread_getaffinity. The supported platforms are Linux, Freebsd, and Windows. Empty implementations (returning UV_ENOTSUP) on non-supported platforms (such as OS X and AIX).
* doc: add uv_poll_cb status==UV_EBADF note (#3797)jensbjorgensen2022-10-21
|
* unix,win: give thread pool threads an 8 MB stack (#3787)Ben Noordhuis2022-10-18
| | | | | | Give the threads in the thread pool a stack size that is consistent across platforms and architectures. Fixes: https://github.com/libuv/libuv/issues/3786
* doc: add note about offset -1 in uv_fs_read/write (#3677)Steven Schveighoffer2022-09-07
|
* unix: fix uv_getrusage() ru_maxrss reporting (#3721)Ben Noordhuis2022-08-21
| | | | | | Most platforms report it in kilobytes but macOS and Solaris report it in bytes and pages respectively. Fixes: https://github.com/nodejs/node/issues/44332
* docs: update introduction.rst (#3664)Ikko Ashimine2022-07-07
| | | Github -> GitHub
* doc: fix link to uvwget example main() function (#3605)blogdaren2022-04-27
|
* unix,win: add uv_available_parallelism() (#3499)Ben Noordhuis2022-03-04
| | | | | | | Replacement for the usage pattern where people use uv_cpu_info() as an imperfect heuristic for determining the amount of parallelism that is available to their programs. Fixes #3493.
* doc: checkout -> check out (#3489)wyckster2022-02-22
| | | | "check out" is a verb phrase, but "checkout" is a noun. Since it is being used as a verb, the spelling "check out" is required.
* document the values of enum uv_stdio_flags (#3039)Paul Evans2022-02-14
| | | Co-authored-by: Jameson Nash <vtjnash@gmail.com>
* win: return fractional seconds in uv_uptime() (#3455)Luca Adrian L2022-02-08
| | | | | | Some systems return fractional seconds, some return full seconds. On Windows uptime was artificially rounded down. Fixes #3447.
* doc/guide: update content and sample code (#3408)woclass2022-01-31
| | | | | | | | | | | | | | | | | | | | - Add `Makefile` for example codes. (cherry-pick from old uvbook repo) - Add a new example "Default loop" to "Basics of libuv"/"Default loop" - Document review and update: `Introduction`, `Basics of libuv`, `Filesystem` + Update the referenced libuv code snippet + Link update: http->https **Content Updates**: - `filesystem.rst`#L291-L297: Add note for `uv_fs_event_start` - `filesystem.rst`#L334: Add description of the callback function parameter `status` The following examples have been tested manually in WSL2 (Ubuntu 20.04) with libuv 1.42.0: - helloworld - default-loop - idle-basic - uvcat - uvtee - onchange (test on macOS) Co-authored-by: Nikhil Marathe <nsm.nikhil@gmail.com>
* unix,win: add uv_ip_name to get name from sockaddr (#3368)Campbell He2021-11-25
| | | | | uv_ip_name is a kind of wrapper of uv_ip4_name and uv_ip6_name which can be used after getaddrinfo to get the IP name directly from addrinfo.ai_addr.
* doc: replace pyuv with uvloop (#3324)Ofek Lev2021-10-10
| | | | | | - pyuv is not actively maintained - uvloop is downloaded 11M/mo, pyuv only 25k/mo Refs: https://github.com/saghul/pyuv/issues/270#issuecomment-925106097
* doc: fix broken links for netbsd's sysctl manpage (#3312)YAKSH BARIYA2021-10-05
|
* docs: fix wrong information about schedulingMohamed Edrah2021-07-29
| | | | | | Fixes: https://github.com/libuv/libuv/issues/3252 PR-URL: https://github.com/libuv/libuv/pull/3253 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Jameson Nash <vtjnash@gmail.com>
* doc,udp: note that suggested_size is 1 max-sized dgramRyan Liptak2021-07-13
| | | | | | | | | | | | The intention here is to make working with recvmmsg more straight-forward, since internally libuv expects buffers that are multiples of UV__UDP_DGRAM_MAXSIZE, but previously the availability of that value wasn't readily apparent to the caller. Closes: https://github.com/libuv/libuv/issues/2822 Closes: https://github.com/libuv/libuv/issues/1025 Closes: https://github.com/libuv/libuv/pull/1114 PR-URL: https://github.com/libuv/libuv/pull/2986 Reviewed-By: Jameson Nash <vtjnash@gmail.com>
* doc: switch discussion forum to githubJameson Nash2021-06-30
| | | | | | | | | Freenode is gone (replaced by Libera.chat), but IRC was unused anyways. Fixes: https://github.com/libuv/libuv/issues/3157 Fixes: https://github.com/libuv/libuv/issues/3208 PR-URL: https://github.com/libuv/libuv/pull/3214 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* docs: move list of project links under PR controlJameson Nash2021-06-22
| | | | | | | | Copied from https://github.com/libuv/libuv/wiki/Projects-that-use-libuv, since the wiki was vulnerable to spam content. PR-URL: https://github.com/libuv/libuv/pull/3204 Reviewed-By: Richard Lau <riclau@uk.ibm.com>
* doc: more accurate list of valid send_handle'stwosee2021-06-18
| | | | PR-URL: https://github.com/libuv/libuv/pull/3201 Reviewed-By: Jameson Nash <vtjnash@gmail.com>
* stream: introduce uv_try_write2 functiontwosee2021-05-28
| | | | | | | | | | `uv_try_write2(stream, bufs, nbufs, send_handle)` acts like `uv_try_write()` and extended write function for sending handles over a pipe like `uv_write2`. It always returns `UV_EAGAIN` instead of `UV_ENOSYS` on Windows so we can easily write cross-platform code without special treatment. PR-URL: https://github.com/libuv/libuv/pull/3183 Reviewed-By: Jameson Nash <vtjnash@gmail.com>
* doc: uv_read_stop always succeedsSimon Kissane2021-05-24
| | | | | | Fixes: https://github.com/libuv/libuv/issues/3041 PR-URL: https://github.com/libuv/libuv/pull/3076 Reviewed-By: Jameson Nash <vtjnash@gmail.com>