| 1 | /** @file
|
|---|
| 2 | * IPRT - Network Sockets.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2006-2012 Oracle Corporation
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 9 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 10 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 11 | * General Public License (GPL) as published by the Free Software
|
|---|
| 12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 15 | *
|
|---|
| 16 | * The contents of this file may alternatively be used under the terms
|
|---|
| 17 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 19 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 20 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 21 | *
|
|---|
| 22 | * You may elect to license modified versions of this file under the
|
|---|
| 23 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 24 | */
|
|---|
| 25 |
|
|---|
| 26 | #ifndef ___iprt_socket_h
|
|---|
| 27 | #define ___iprt_socket_h
|
|---|
| 28 |
|
|---|
| 29 | #include <iprt/cdefs.h>
|
|---|
| 30 | #include <iprt/types.h>
|
|---|
| 31 | #include <iprt/thread.h>
|
|---|
| 32 | #include <iprt/net.h>
|
|---|
| 33 | #include <iprt/sg.h>
|
|---|
| 34 |
|
|---|
| 35 | #ifdef IN_RING0
|
|---|
| 36 | # error "There are no RTSocket APIs available Ring-0 Host Context!"
|
|---|
| 37 | #endif
|
|---|
| 38 |
|
|---|
| 39 |
|
|---|
| 40 | RT_C_DECLS_BEGIN
|
|---|
| 41 |
|
|---|
| 42 | /** @defgroup grp_rt_tcp RTSocket - Network Sockets
|
|---|
| 43 | * @ingroup grp_rt
|
|---|
| 44 | * @{
|
|---|
| 45 | */
|
|---|
| 46 |
|
|---|
| 47 | /**
|
|---|
| 48 | * Retains a reference to the socket handle.
|
|---|
| 49 | *
|
|---|
| 50 | * @returns New reference count, UINT32_MAX on invalid handle (asserted).
|
|---|
| 51 | *
|
|---|
| 52 | * @param hSocket The socket handle.
|
|---|
| 53 | */
|
|---|
| 54 | RTDECL(uint32_t) RTSocketRetain(RTSOCKET hSocket);
|
|---|
| 55 |
|
|---|
| 56 | /**
|
|---|
| 57 | * Release a reference to the socket handle.
|
|---|
| 58 | *
|
|---|
| 59 | * When the reference count reaches zero, the socket handle is shut down and
|
|---|
| 60 | * destroyed. This will not be graceful shutdown, use the protocol specific
|
|---|
| 61 | * close method if this is desired.
|
|---|
| 62 | *
|
|---|
| 63 | * @returns New reference count, UINT32_MAX on invalid handle (asserted).
|
|---|
| 64 | *
|
|---|
| 65 | * @param hSocket The socket handle. The NIL handle is quietly
|
|---|
| 66 | * ignored and 0 is returned.
|
|---|
| 67 | */
|
|---|
| 68 | RTDECL(uint32_t) RTSocketRelease(RTSOCKET hSocket);
|
|---|
| 69 |
|
|---|
| 70 | /**
|
|---|
| 71 | * Shuts down the socket, close it and then release one handle reference.
|
|---|
| 72 | *
|
|---|
| 73 | * This is slightly different from RTSocketRelease which will first do the
|
|---|
| 74 | * shutting down and closing when the reference count reaches zero.
|
|---|
| 75 | *
|
|---|
| 76 | * @returns IPRT status code.
|
|---|
| 77 | * @param hSocket The socket handle. NIL is ignored.
|
|---|
| 78 | *
|
|---|
| 79 | * @remarks This will not perform a graceful shutdown of the socket, it will
|
|---|
| 80 | * just destroy it. Use the protocol specific close method if this is
|
|---|
| 81 | * desired.
|
|---|
| 82 | */
|
|---|
| 83 | RTDECL(int) RTSocketClose(RTSOCKET hSocket);
|
|---|
| 84 |
|
|---|
| 85 | /**
|
|---|
| 86 | * Creates an IPRT socket handle from a native one.
|
|---|
| 87 | *
|
|---|
| 88 | * Do NOT use the native handle after passing it to this function, IPRT owns it
|
|---|
| 89 | * and might even have closed upon a successful return.
|
|---|
| 90 | *
|
|---|
| 91 | * @returns IPRT status code.
|
|---|
| 92 | * @param phSocket Where to store the IPRT socket handle.
|
|---|
| 93 | * @param uNative The native handle.
|
|---|
| 94 | */
|
|---|
| 95 | RTDECL(int) RTSocketFromNative(PRTSOCKET phSocket, RTHCINTPTR uNative);
|
|---|
| 96 |
|
|---|
| 97 | /**
|
|---|
| 98 | * Gets the native socket handle.
|
|---|
| 99 | *
|
|---|
| 100 | * @returns The native socket handle or RTHCUINTPTR_MAX if not invalid.
|
|---|
| 101 | * @param hSocket The socket handle.
|
|---|
| 102 | */
|
|---|
| 103 | RTDECL(RTHCUINTPTR) RTSocketToNative(RTSOCKET hSocket);
|
|---|
| 104 |
|
|---|
| 105 | /**
|
|---|
| 106 | * Helper that ensures the correct inheritability of a socket.
|
|---|
| 107 | *
|
|---|
| 108 | * We're currently ignoring failures.
|
|---|
| 109 | *
|
|---|
| 110 | * @returns IPRT status code
|
|---|
| 111 | * @param hSocket The socket handle.
|
|---|
| 112 | * @param fInheritable The desired inheritability state.
|
|---|
| 113 | */
|
|---|
| 114 | RTDECL(int) RTSocketSetInheritance(RTSOCKET hSocket, bool fInheritable);
|
|---|
| 115 |
|
|---|
| 116 | /**
|
|---|
| 117 | * Parse Internet style addresses, getting a generic IPRT network address.
|
|---|
| 118 | *
|
|---|
| 119 | * @returns IPRT status code
|
|---|
| 120 | * @param pszAddress Name or IP address. NULL or empty string (no
|
|---|
| 121 | * spaces) is taken to mean INADDR_ANY, which is
|
|---|
| 122 | * meaningful when binding a server socket for
|
|---|
| 123 | * instance.
|
|---|
| 124 | * @param uPort Port number (host byte order).
|
|---|
| 125 | * @param pAddr Where to return the generic IPRT network address.
|
|---|
| 126 | */
|
|---|
| 127 | RTDECL(int) RTSocketParseInetAddress(const char *pszAddress, unsigned uPort, PRTNETADDR pAddr);
|
|---|
| 128 |
|
|---|
| 129 | /**
|
|---|
| 130 | * Try resolve a host name, returning the first matching address.
|
|---|
| 131 | *
|
|---|
| 132 | * @returns IPRT status code.
|
|---|
| 133 | * @param pszHost Name or IP address to look up.
|
|---|
| 134 | * @param pszAddress Where to return the stringified address.
|
|---|
| 135 | * @param pcbAddress Input: The size of the @a pszResult buffer.
|
|---|
| 136 | * Output: size of the returned string. This is set on
|
|---|
| 137 | * VERR_BUFFER_OVERFLOW and most other error statuses.
|
|---|
| 138 | * @param penmAddrType Input: Which kind of address to return. Valid values
|
|---|
| 139 | * are:
|
|---|
| 140 | * - RTNETADDRTYPE_IPV4 -> lookup AF_INET.
|
|---|
| 141 | * - RTNETADDRTYPE_IPV6 -> lookup AF_INET6.
|
|---|
| 142 | * - RTNETADDRTYPE_INVALID/NULL -> lookup anything.
|
|---|
| 143 | * Output: The type of address that is being returned.
|
|---|
| 144 | * Not modified on failure.
|
|---|
| 145 | */
|
|---|
| 146 | RTDECL(int) RTSocketQueryAddressStr(const char *pszHost, char *pszAddress, size_t *pcbAddress, PRTNETADDRTYPE penmAddrType);
|
|---|
| 147 |
|
|---|
| 148 | /**
|
|---|
| 149 | * Receive data from a socket.
|
|---|
| 150 | *
|
|---|
| 151 | * @returns IPRT status code.
|
|---|
| 152 | * @param hSocket The socket handle.
|
|---|
| 153 | * @param pvBuffer Where to put the data we read.
|
|---|
| 154 | * @param cbBuffer Read buffer size.
|
|---|
| 155 | * @param pcbRead Number of bytes read. If NULL the entire buffer
|
|---|
| 156 | * will be filled upon successful return. If not NULL a
|
|---|
| 157 | * partial read can be done successfully.
|
|---|
| 158 | */
|
|---|
| 159 | RTDECL(int) RTSocketRead(RTSOCKET hSocket, void *pvBuffer, size_t cbBuffer, size_t *pcbRead);
|
|---|
| 160 |
|
|---|
| 161 | /**
|
|---|
| 162 | * Receive data from a socket, including sender address. Mainly useful
|
|---|
| 163 | * for datagram sockets.
|
|---|
| 164 | *
|
|---|
| 165 | * @returns IPRT status code.
|
|---|
| 166 | * @param hSocket The socket handle.
|
|---|
| 167 | * @param pvBuffer Where to put the data we read.
|
|---|
| 168 | * @param cbBuffer Read buffer size.
|
|---|
| 169 | * @param pcbRead Number of bytes read. Must be non-NULL.
|
|---|
| 170 | * @param pSrcAddr Pointer to sender address buffer. May be NULL.
|
|---|
| 171 | */
|
|---|
| 172 | RTDECL(int) RTSocketReadFrom(RTSOCKET hSocket, void *pvBuffer, size_t cbBuffer, size_t *pcbRead, PRTNETADDR pSrcAddr);
|
|---|
| 173 |
|
|---|
| 174 | /**
|
|---|
| 175 | * Send data to a socket.
|
|---|
| 176 | *
|
|---|
| 177 | * @returns IPRT status code.
|
|---|
| 178 | * @retval VERR_INTERRUPTED if interrupted before anything was written.
|
|---|
| 179 | *
|
|---|
| 180 | * @param hSocket The socket handle.
|
|---|
| 181 | * @param pvBuffer Buffer to write data to socket.
|
|---|
| 182 | * @param cbBuffer How much to write.
|
|---|
| 183 | */
|
|---|
| 184 | RTDECL(int) RTSocketWrite(RTSOCKET hSocket, const void *pvBuffer, size_t cbBuffer);
|
|---|
| 185 |
|
|---|
| 186 | /**
|
|---|
| 187 | * Send data to a socket, including destination address. Mainly useful
|
|---|
| 188 | * for datagram sockets.
|
|---|
| 189 | *
|
|---|
| 190 | * @returns IPRT status code.
|
|---|
| 191 | * @retval VERR_INTERRUPTED if interrupted before anything was written.
|
|---|
| 192 | *
|
|---|
| 193 | * @param hSocket The socket handle.
|
|---|
| 194 | * @param pvBuffer Buffer to write data to socket.
|
|---|
| 195 | * @param cbBuffer How much to write.
|
|---|
| 196 | * @param pDstAddr Pointer to destination address. May be NULL.
|
|---|
| 197 | */
|
|---|
| 198 | RTDECL(int) RTSocketWriteTo(RTSOCKET hSocket, const void *pvBuffer, size_t cbBuffer, PCRTNETADDR pDstAddr);
|
|---|
| 199 |
|
|---|
| 200 | /**
|
|---|
| 201 | * Checks if the socket is ready for reading (for I/O multiplexing).
|
|---|
| 202 | *
|
|---|
| 203 | * @returns IPRT status code.
|
|---|
| 204 | * @param hSocket The socket handle.
|
|---|
| 205 | * @param cMillies Number of milliseconds to wait for the socket. Use
|
|---|
| 206 | * RT_INDEFINITE_WAIT to wait for ever.
|
|---|
| 207 | */
|
|---|
| 208 | RTDECL(int) RTSocketSelectOne(RTSOCKET hSocket, RTMSINTERVAL cMillies);
|
|---|
| 209 |
|
|---|
| 210 | /** @name Select events
|
|---|
| 211 | * @{ */
|
|---|
| 212 | /** Readable without blocking. */
|
|---|
| 213 | #define RTSOCKET_EVT_READ RT_BIT_32(0)
|
|---|
| 214 | /** Writable without blocking. */
|
|---|
| 215 | #define RTSOCKET_EVT_WRITE RT_BIT_32(1)
|
|---|
| 216 | /** Error condition, hangup, exception or similar. */
|
|---|
| 217 | #define RTSOCKET_EVT_ERROR RT_BIT_32(2)
|
|---|
| 218 | /** Mask of the valid bits. */
|
|---|
| 219 | #define RTSOCKET_EVT_VALID_MASK UINT32_C(0x00000007)
|
|---|
| 220 | /** @} */
|
|---|
| 221 |
|
|---|
| 222 | /**
|
|---|
| 223 | * Socket I/O multiplexing
|
|---|
| 224 | * Checks if the socket is ready for one of the given events.
|
|---|
| 225 | *
|
|---|
| 226 | * @returns iprt status code.
|
|---|
| 227 | * @param Sock Socket descriptor.
|
|---|
| 228 | * @param fEvents Event mask to wait for.
|
|---|
| 229 | * @param pfEvents Where to store the event mask on return.
|
|---|
| 230 | * @param cMillies Number of milliseconds to wait for the socket.
|
|---|
| 231 | * Use RT_INDEFINITE_WAIT to wait for ever.
|
|---|
| 232 | */
|
|---|
| 233 | RTR3DECL(int) RTSocketSelectOneEx(RTSOCKET Sock, uint32_t fEvents, uint32_t *pfEvents,
|
|---|
| 234 | RTMSINTERVAL cMillies);
|
|---|
| 235 |
|
|---|
| 236 | /**
|
|---|
| 237 | * Shuts down one or both directions of communciation.
|
|---|
| 238 | *
|
|---|
| 239 | * @returns IPRT status code.
|
|---|
| 240 | * @param hSocket The socket handle.
|
|---|
| 241 | * @param fRead Whether to shutdown our read direction.
|
|---|
| 242 | * @param fWrite Whether to shutdown our write direction.
|
|---|
| 243 | */
|
|---|
| 244 | RTDECL(int) RTSocketShutdown(RTSOCKET hSocket, bool fRead, bool fWrite);
|
|---|
| 245 |
|
|---|
| 246 | /**
|
|---|
| 247 | * Gets the address of the local side.
|
|---|
| 248 | *
|
|---|
| 249 | * @returns IPRT status code.
|
|---|
| 250 | * @param Sock Socket descriptor.
|
|---|
| 251 | * @param pAddr Where to store the local address on success.
|
|---|
| 252 | */
|
|---|
| 253 | RTDECL(int) RTSocketGetLocalAddress(RTSOCKET hSocket, PRTNETADDR pAddr);
|
|---|
| 254 |
|
|---|
| 255 | /**
|
|---|
| 256 | * Gets the address of the other party.
|
|---|
| 257 | *
|
|---|
| 258 | * @returns IPRT status code.
|
|---|
| 259 | * @param Sock Socket descriptor.
|
|---|
| 260 | * @param pAddr Where to store the peer address on success.
|
|---|
| 261 | */
|
|---|
| 262 | RTDECL(int) RTSocketGetPeerAddress(RTSOCKET hSocket, PRTNETADDR pAddr);
|
|---|
| 263 |
|
|---|
| 264 | /**
|
|---|
| 265 | * Send data from a scatter/gather buffer to a socket.
|
|---|
| 266 | *
|
|---|
| 267 | * @returns IPRT status code.
|
|---|
| 268 | * @retval VERR_INTERRUPTED if interrupted before anything was written.
|
|---|
| 269 | *
|
|---|
| 270 | * @param hSocket The socket handle.
|
|---|
| 271 | * @param pSgBuf Scatter/gather buffer to write data to socket.
|
|---|
| 272 | */
|
|---|
| 273 | RTDECL(int) RTSocketSgWrite(RTSOCKET hSocket, PCRTSGBUF pSgBuf);
|
|---|
| 274 |
|
|---|
| 275 | /**
|
|---|
| 276 | * Send data from multiple buffers to a socket.
|
|---|
| 277 | *
|
|---|
| 278 | * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
|
|---|
| 279 | * for lazy coders. The "L" in the function name is short for "list" just like
|
|---|
| 280 | * in the execl libc API.
|
|---|
| 281 | *
|
|---|
| 282 | * @returns IPRT status code.
|
|---|
| 283 | * @retval VERR_INTERRUPTED if interrupted before anything was written.
|
|---|
| 284 | *
|
|---|
| 285 | * @param hSocket The socket handle.
|
|---|
| 286 | * @param cSegs The number of data segments in the following
|
|---|
| 287 | * ellipsis.
|
|---|
| 288 | * @param ... Pairs of buffer pointers (void const *) and buffer
|
|---|
| 289 | * sizes (size_t). Make 101% sure the pointer is
|
|---|
| 290 | * really size_t.
|
|---|
| 291 | */
|
|---|
| 292 | RTDECL(int) RTSocketSgWriteL(RTSOCKET hSocket, size_t cSegs, ...);
|
|---|
| 293 |
|
|---|
| 294 | /**
|
|---|
| 295 | * Send data from multiple buffers to a socket.
|
|---|
| 296 | *
|
|---|
| 297 | * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
|
|---|
| 298 | * for lazy coders. The "L" in the function name is short for "list" just like
|
|---|
| 299 | * in the execl libc API.
|
|---|
| 300 | *
|
|---|
| 301 | * @returns IPRT status code.
|
|---|
| 302 | * @retval VERR_INTERRUPTED if interrupted before anything was written.
|
|---|
| 303 | *
|
|---|
| 304 | * @param hSocket The socket handle.
|
|---|
| 305 | * @param cSegs The number of data segments in the following
|
|---|
| 306 | * argument list.
|
|---|
| 307 | * @param va Pairs of buffer pointers (void const *) and buffer
|
|---|
| 308 | * sizes (size_t). Make 101% sure the pointer is
|
|---|
| 309 | * really size_t.
|
|---|
| 310 | */
|
|---|
| 311 | RTDECL(int) RTSocketSgWriteLV(RTSOCKET hSocket, size_t cSegs, va_list va);
|
|---|
| 312 |
|
|---|
| 313 | /**
|
|---|
| 314 | * Receive data from a socket.
|
|---|
| 315 | *
|
|---|
| 316 | * This version doesn't block if there is no data on the socket.
|
|---|
| 317 | *
|
|---|
| 318 | * @returns IPRT status code.
|
|---|
| 319 | *
|
|---|
| 320 | * @param hSocket The socket handle.
|
|---|
| 321 | * @param pvBuffer Where to put the data we read.
|
|---|
| 322 | * @param cbBuffer Read buffer size.
|
|---|
| 323 | * @param pcbRead Number of bytes read.
|
|---|
| 324 | */
|
|---|
| 325 | RTDECL(int) RTSocketReadNB(RTSOCKET hSocket, void *pvBuffer, size_t cbBuffer, size_t *pcbRead);
|
|---|
| 326 |
|
|---|
| 327 | /**
|
|---|
| 328 | * Send data to a socket.
|
|---|
| 329 | *
|
|---|
| 330 | * This version doesn't block if there is not enough room for the message.
|
|---|
| 331 | *
|
|---|
| 332 | * @returns IPRT status code.
|
|---|
| 333 | *
|
|---|
| 334 | * @param hSocket The socket handle.
|
|---|
| 335 | * @param pvBuffer Buffer to write data to socket.
|
|---|
| 336 | * @param cbBuffer How much to write.
|
|---|
| 337 | * @param pcbWritten Number of bytes written.
|
|---|
| 338 | */
|
|---|
| 339 | RTDECL(int) RTSocketWriteNB(RTSOCKET hSocket, const void *pvBuffer, size_t cbBuffer, size_t *pcbWritten);
|
|---|
| 340 |
|
|---|
| 341 | /**
|
|---|
| 342 | * Send data from a scatter/gather buffer to a socket.
|
|---|
| 343 | *
|
|---|
| 344 | * This version doesn't block if there is not enough room for the message.
|
|---|
| 345 | *
|
|---|
| 346 | * @returns iprt status code.
|
|---|
| 347 | *
|
|---|
| 348 | * @param Sock Socket descriptor.
|
|---|
| 349 | * @param pSgBuf Scatter/gather buffer to write data to socket.
|
|---|
| 350 | * @param pcbWritten Number of bytes written.
|
|---|
| 351 | */
|
|---|
| 352 | RTR3DECL(int) RTSocketSgWriteNB(RTSOCKET Sock, PCRTSGBUF pSgBuf, size_t *pcbWritten);
|
|---|
| 353 |
|
|---|
| 354 |
|
|---|
| 355 | /**
|
|---|
| 356 | * Send data from multiple buffers to a socket.
|
|---|
| 357 | *
|
|---|
| 358 | * This version doesn't block if there is not enough room for the message.
|
|---|
| 359 | * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
|
|---|
| 360 | * for lazy coders. The "L" in the function name is short for "list" just like
|
|---|
| 361 | * in the execl libc API.
|
|---|
| 362 | *
|
|---|
| 363 | * @returns IPRT status code.
|
|---|
| 364 | *
|
|---|
| 365 | * @param hSocket The socket handle.
|
|---|
| 366 | * @param cSegs The number of data segments in the following
|
|---|
| 367 | * ellipsis.
|
|---|
| 368 | * @param pcbWritten Number of bytes written.
|
|---|
| 369 | * @param ... Pairs of buffer pointers (void const *) and buffer
|
|---|
| 370 | * sizes (size_t). Make 101% sure the pointer is
|
|---|
| 371 | * really size_t.
|
|---|
| 372 | */
|
|---|
| 373 | RTR3DECL(int) RTSocketSgWriteLNB(RTSOCKET hSocket, size_t cSegs, size_t *pcbWritten, ...);
|
|---|
| 374 |
|
|---|
| 375 | /**
|
|---|
| 376 | * Send data from multiple buffers to a socket.
|
|---|
| 377 | *
|
|---|
| 378 | * This version doesn't block if there is not enough room for the message.
|
|---|
| 379 | * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
|
|---|
| 380 | * for lazy coders. The "L" in the function name is short for "list" just like
|
|---|
| 381 | * in the execl libc API.
|
|---|
| 382 | *
|
|---|
| 383 | * @returns IPRT status code.
|
|---|
| 384 | *
|
|---|
| 385 | * @param hSocket The socket handle.
|
|---|
| 386 | * @param cSegs The number of data segments in the following
|
|---|
| 387 | * argument list.
|
|---|
| 388 | * @param pcbWritten Number of bytes written.
|
|---|
| 389 | * @param va Pairs of buffer pointers (void const *) and buffer
|
|---|
| 390 | * sizes (size_t). Make 101% sure the pointer is
|
|---|
| 391 | * really size_t.
|
|---|
| 392 | */
|
|---|
| 393 | RTR3DECL(int) RTSocketSgWriteLVNB(RTSOCKET hSocket, size_t cSegs, size_t *pcbWritten, va_list va);
|
|---|
| 394 |
|
|---|
| 395 | /** @} */
|
|---|
| 396 | RT_C_DECLS_END
|
|---|
| 397 |
|
|---|
| 398 | #endif
|
|---|
| 399 |
|
|---|
