diff options
| author | Ryan Liptak <squeek502@hotmail.com> | 2021-07-13 08:20:53 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-13 11:20:53 -0400 |
| commit | 5c85d67bc781430f2db8f446795494aa8d399de8 (patch) | |
| tree | b4752d18c77bc95332546b8cbbe61181b2e790c4 /docs/src | |
| parent | 03f1a6979caff380bfcfcd1293390474eaad6164 (diff) | |
| download | libuv-5c85d67bc781430f2db8f446795494aa8d399de8.tar.gz libuv-5c85d67bc781430f2db8f446795494aa8d399de8.zip | |
doc,udp: note that suggested_size is 1 max-sized dgram
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>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/udp.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/src/udp.rst b/docs/src/udp.rst index 3a7c6db4..009767d5 100644 --- a/docs/src/udp.rst +++ b/docs/src/udp.rst @@ -404,6 +404,11 @@ API :returns: 0 on success, or an error code < 0 on failure. + .. note:: + When using :man:`recvmmsg(2)`, the number of messages received at a time is limited + by the number of max size dgrams that will fit into the buffer allocated in `alloc_cb`, and + `suggested_size` in `alloc_cb` for udp_recv is always set to the size of 1 max size dgram. + .. versionchanged:: 1.35.0 added support for :man:`recvmmsg(2)` on supported platforms). The use of this feature requires a buffer larger than 2 * 64KB to be passed to `alloc_cb`. |