Changeset 45948 in vbox for trunk/include

Timestamp:

May 8, 2013 12:32:54 PM (12 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

85595

Message:

IPRT: Added RTTcpClientConnectEx and RTTcpClientCancelConnect.

Location:

trunk/include/iprt

Files:

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

trunk/include/iprt/mangling.h

@@ -1445 +1445 @@
 # define RTTarOpen                                      RT_MANGLER(RTTarOpen)
 # define RTTarSeekNextFile                              RT_MANGLER(RTTarSeekNextFile)
+# define RTTcpClientCancelConnect                       RT_MANGLER(RTTcpClientCancelConnect)
 # define RTTcpClientClose                               RT_MANGLER(RTTcpClientClose)
 # define RTTcpClientCloseEx                             RT_MANGLER(RTTcpClientCloseEx)
 # define RTTcpClientConnect                             RT_MANGLER(RTTcpClientConnect)
+# define RTTcpClientConnectEx                           RT_MANGLER(RTTcpClientConnectEx)
 # define RTTcpFlush                                     RT_MANGLER(RTTcpFlush)
 # define RTTcpGetLocalAddress                           RT_MANGLER(RTTcpGetLocalAddress)

trunk/include/iprt/tcp.h

@@ -171 +171 @@
 RTR3DECL(int) RTTcpClientConnect(const char *pszAddress, uint32_t uPort, PRTSOCKET pSock);
 
+/** Opaque pointer used by RTTcpClientConnectEx and RTTcpClientCancelConnect. */
+typedef struct RTTCPCLIENTCONNECTCANCEL *PRTTCPCLIENTCONNECTCANCEL;
+
+/**
+ * Connect (as a client) to a TCP Server, extended version.
+ *
+ * @returns iprt status code.
+ * @param   pszAddress      The address to connect to.
+ * @param   uPort           The port to connect to.
+ * @param   pSock           Where to store the handle to the established connection.
+ * @param   ppCancelCookie  Where to store information for canceling the
+ *                          operation (from a different thread). Optional.
+ *
+ *                          The pointer _must_ be initialized to NULL before a
+ *                          series of connection attempts begins, i.e. at a time
+ *                          where there will be no RTTcpClientCancelConnect
+ *                          calls racing access.  RTTcpClientCancelConnect will
+ *                          set it to a special non-NULL value that causes the
+ *                          current or/and next connect call to fail.
+ *
+ * @sa      RTTcpClientCancelConnect
+ */
+RTR3DECL(int) RTTcpClientConnectEx(const char *pszAddress, uint32_t uPort, PRTSOCKET pSock,
+                                   PRTTCPCLIENTCONNECTCANCEL volatile *ppCancelCookie);
+
+/**
+ * Cancels a RTTcpClientConnectEx call on a different thread.
+ *
+ * @returns iprt status code.
+ * @param   ppCancelCookie  The address of the cookie pointer shared with the
+ *                          connect call.
+ */
+RTR3DECL(int) RTTcpClientCancelConnect(PRTTCPCLIENTCONNECTCANCEL volatile *ppCancelCookie);
+
 /**
  * Close a socket returned by RTTcpClientConnect().