Changeset 100171 in vbox for trunk/include

Timestamp:

Jun 13, 2023 9:07:56 PM (18 months ago)

Author:

vboxsync

Message:

IPRT: tcp.h+tcp.cpp,socket.h+socket.cpp: Add RTTcpSetKeepAlive() which
allows one to enable or disable sending periodic keep-alive messages on
a socket (SO_KEEPALIVE) as described in RFC 1122. RTTcpSetKeepAlive()
also allows one to adjust several keep-alive options on a per-socket
basis: the idle time before keep-alive probes are sent (TCP_KEEPIDLE
(TCP_KEEPALIVE on macOS)), the amount of time between keep-alive probes
(TCP_KEEPINTVL), and the number of keep-alive probes to send before
closing the connection (TCP_KEEPCNT).

Location:

trunk/include/iprt

Files:

• mangling.h (modified) (1 diff)
• tcp.h (modified) (1 diff)

trunk/include/iprt/mangling.h

@@ -2472 +2472 @@
 # define RTTcpServerListen2                             RT_MANGLER(RTTcpServerListen2)
 # define RTTcpServerShutdown                            RT_MANGLER(RTTcpServerShutdown)
+# define RTTcpSetBufferSize                             RT_MANGLER(RTTcpSetBufferSize)
+# define RTTcpSetKeepAlive                              RT_MANGLER(RTTcpSetKeepAlive)
 # define RTTcpSetSendCoalescing                         RT_MANGLER(RTTcpSetSendCoalescing)
-# define RTTcpSetBufferSize                             RT_MANGLER(RTTcpSetBufferSize)
 # define RTTcpSgWrite                                   RT_MANGLER(RTTcpSgWrite)
 # define RTTcpSgWriteL                                  RT_MANGLER(RTTcpSgWriteL)

trunk/include/iprt/tcp.h

@@ -310 +310 @@
 
 /**
+ * Enables or disables sending of periodic keep-alive messages on a socket.
+ * Also set values relating to TCP keep-alive messages on a socket.  The TCP
+ * keep-alive mechanism is described in RFC 1122 which states:
+ * "Keep-alive packets MUST only be sent when no data or acknowledgement
+ * packets have been received for the connection within an interval. This
+ * interval MUST be configurable and MUST default to no less than two hours."
+ * The following per-socket options allow fine-tuning the keep-alive interval,
+ * frequency, and timeout when SO_KEEPALIVE has been set for the socket.
+ *
+ * @returns iprt status code.
+ * @retval  VERR_NOT_SUPPORTED is returned if these keep-alive options aren't
+ *          supported by the OS.
+ *
+ * @param   hSocket                 Socket descriptor.
+ * @param   fEnable                 When set to true enables keep-alive messages.
+ * @param   cSecsIdle               The amount of time, in seconds, that the connection must be idle before
+ *                                  keep-alive probes are sent for this socket. (TCP_KEEPIDLE (TCP_KEEPALIVE on macOS))
+ *                                  If zero then the system default is used (the default value varies by OS
+ *                                  but is typically 2 hours (7200 seconds)).
+ * @param   cSecsInterval           The amount of time, in seconds, between each keep-alive probe sent to a
+ *                                  peer. (TCP_KEEPINTVL)
+ *                                  If zero then the system default is used (the default value varies by OS
+ *                                  but is typically 75 seconds).
+ * @param   cFailedPktsBeforeClose  The number of keep-alive probes to send which receive no response before
+ *                                  closing the connection. (TCP_KEEPCNT)
+ *                                  If zero then the system default is used (the default value varies by OS
+ *                                  but is typically 8 packets).
+ */
+RTR3DECL(int)  RTTcpSetKeepAlive(RTSOCKET hSocket, bool fEnable, uint32_t cSecsIdle, uint32_t cSecsInterval,
+                                 uint32_t cFailedPktsBeforeClose);
+
+/**
  * Socket I/O multiplexing.
  * Checks if the socket is ready for reading.