diff options
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/tcp.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/src/tcp.rst b/docs/src/tcp.rst index d20a6362..bcb163ea 100644 --- a/docs/src/tcp.rst +++ b/docs/src/tcp.rst @@ -113,3 +113,13 @@ API mapping .. seealso:: The :c:type:`uv_stream_t` API functions also apply. + +.. c:function:: int uv_tcp_close_reset(uv_tcp_t* handle, uv_close_cb close_cb) + + Resets a TCP connection by sending a RST packet. This is accomplished by + setting the `SO_LINGER` socket option with a linger interval of zero and + then calling :c:func:`uv_close`. + Due to some platform inconsistencies, mixing of :c:func:`uv_shutdown` and + :c:func:`uv_tcp_close_reset` calls is not allowed. + + .. versionadded:: 1.32.0 |