include/qemu/sockets.h

   1 /* headers to use the BSD sockets */
   2
   3 #ifndef QEMU_SOCKETS_H
   4 #define QEMU_SOCKETS_H
   5
   6 #ifdef _WIN32
   7
   8 int inet_aton(const char *cp, struct in_addr *ia);
   9
  10 #endif /* !_WIN32 */
  11
  12 #include "qapi-types.h"
  13
  14 /* misc helpers */
  15 int qemu_socket(int domain, int type, int protocol);
  16 int qemu_accept(int s, struct sockaddr *addr, socklen_t *addrlen);
  17 int socket_set_cork(int fd, int v);
  18 int socket_set_nodelay(int fd);
  19 void qemu_set_block(int fd);
  20 void qemu_set_nonblock(int fd);
  21 int socket_set_fast_reuse(int fd);
  22
  23 #ifdef WIN32
  24 /* Windows has different names for the same constants with the same values */
  25 #define SHUT_RD   0
  26 #define SHUT_WR   1
  27 #define SHUT_RDWR 2
  28 #endif
  29
  30 int inet_ai_family_from_address(InetSocketAddress *addr,
  31                                 Error **errp);
  32 int inet_parse(InetSocketAddress *addr, const char *str, Error **errp);
  33 int inet_connect(const char *str, Error **errp);
  34 int inet_connect_saddr(InetSocketAddress *saddr, Error **errp);
  35
  36 NetworkAddressFamily inet_netfamily(int family);
  37
  38 int unix_listen(const char *path, char *ostr, int olen, Error **errp);
  39 int unix_connect(const char *path, Error **errp);
  40
  41 SocketAddress *socket_parse(const char *str, Error **errp);
  42 int socket_connect(SocketAddress *addr, Error **errp);
  43 int socket_listen(SocketAddress *addr, Error **errp);
  44 void socket_listen_cleanup(int fd, Error **errp);
  45 int socket_dgram(SocketAddress *remote, SocketAddress *local, Error **errp);
  46
  47 /* Old, ipv4 only bits.  Don't use for new code. */
  48 int parse_host_port(struct sockaddr_in *saddr, const char *str);
  49 int socket_init(void);
  50
  51 /**
  52  * socket_sockaddr_to_address:
  53  * @sa: socket address struct
  54  * @salen: size of @sa struct
  55  * @errp: pointer to uninitialized error object
  56  *
  57  * Get the string representation of the socket
  58  * address. A pointer to the allocated address information
  59  * struct will be returned, which the caller is required to
  60  * release with a call qapi_free_SocketAddress() when no
  61  * longer required.
  62  *
  63  * Returns: the socket address struct, or NULL on error
  64  */
  65 SocketAddress *
  66 socket_sockaddr_to_address(struct sockaddr_storage *sa,
  67                            socklen_t salen,
  68                            Error **errp);
  69
  70 /**
  71  * socket_local_address:
  72  * @fd: the socket file handle
  73  * @errp: pointer to uninitialized error object
  74  *
  75  * Get the string representation of the local socket
  76  * address. A pointer to the allocated address information
  77  * struct will be returned, which the caller is required to
  78  * release with a call qapi_free_SocketAddress() when no
  79  * longer required.
  80  *
  81  * Returns: the socket address struct, or NULL on error
  82  */
  83 SocketAddress *socket_local_address(int fd, Error **errp);
  84
  85 /**
  86  * socket_remote_address:
  87  * @fd: the socket file handle
  88  * @errp: pointer to uninitialized error object
  89  *
  90  * Get the string representation of the remote socket
  91  * address. A pointer to the allocated address information
  92  * struct will be returned, which the caller is required to
  93  * release with a call qapi_free_SocketAddress() when no
  94  * longer required.
  95  *
  96  * Returns: the socket address struct, or NULL on error
  97  */
  98 SocketAddress *socket_remote_address(int fd, Error **errp);
  99
 100 /**
 101  * socket_address_flatten:
 102  * @addr: the socket address to flatten
 103  *
 104  * Convert SocketAddressLegacy to SocketAddress.  Caller is responsible
 105  * for freeing with qapi_free_SocketAddress().
 106  *
 107  * Returns: the argument converted to SocketAddress.
 108  */
 109 SocketAddress *socket_address_flatten(SocketAddressLegacy *addr);
 110
 111 #endif /* QEMU_SOCKETS_H */