diff options
| author | Ryan Liptak <squeek502@hotmail.com> | 2019-10-10 19:34:04 -0700 |
|---|---|---|
| committer | cjihrig <cjihrig@gmail.com> | 2019-10-14 21:22:57 -0400 |
| commit | e668e10acbd7db9fa82be7ace1320caa5a0def93 (patch) | |
| tree | 5ec27e96dc41900858acb1311137daf4428446f7 /docs/src | |
| parent | 65f142a9a60fb161b54d952b1739591320df0dd4 (diff) | |
| download | libuv-e668e10acbd7db9fa82be7ace1320caa5a0def93.tar.gz libuv-e668e10acbd7db9fa82be7ace1320caa5a0def93.zip | |
doc: improve uv_{send,recv}_buffer_size() docs
PR-URL: https://github.com/libuv/libuv/pull/2508
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/handle.rst | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/src/handle.rst b/docs/src/handle.rst index 0a25bfa8..943c51d9 100644 --- a/docs/src/handle.rst +++ b/docs/src/handle.rst @@ -190,8 +190,11 @@ just for some handle types. Gets or sets the size of the send buffer that the operating system uses for the socket. - If `*value` == 0, it will return the current send buffer size, - otherwise it will use `*value` to set the new send buffer size. + If `*value` == 0, then it will set `*value` to the current send buffer size. + If `*value` > 0 then it will use `*value` to set the new send buffer size. + + On success, zero is returned. On error, a negative result is + returned. This function works for TCP, pipe and UDP handles on Unix and for TCP and UDP handles on Windows. @@ -204,8 +207,11 @@ just for some handle types. Gets or sets the size of the receive buffer that the operating system uses for the socket. - If `*value` == 0, it will return the current receive buffer size, - otherwise it will use `*value` to set the new receive buffer size. + If `*value` == 0, then it will set `*value` to the current receive buffer size. + If `*value` > 0 then it will use `*value` to set the new receive buffer size. + + On success, zero is returned. On error, a negative result is + returned. This function works for TCP, pipe and UDP handles on Unix and for TCP and UDP handles on Windows. |