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 /* callback function for nonblocking connect
  31  * valid fd on success, negative error code on failure
  32  */
  33 typedef void NonBlockingConnectHandler(int fd, Error *err, void *opaque);
  34
  35 int inet_ai_family_from_address(InetSocketAddress *addr,
  36                                 Error **errp);
  37 int inet_parse(InetSocketAddress *addr, const char *str, Error **errp);
  38 int inet_connect(const char *str, Error **errp);
  39 int inet_connect_saddr(InetSocketAddress *saddr,
  40                        NonBlockingConnectHandler *callback, void *opaque,
  41                        Error **errp);
  42
  43 NetworkAddressFamily inet_netfamily(int family);
  44
  45 int unix_listen(const char *path, char *ostr, int olen, Error **errp);
  46 int unix_connect(const char *path, Error **errp);
  47
  48 SocketAddress *socket_parse(const char *str, Error **errp);
  49 int socket_connect(SocketAddress *addr, NonBlockingConnectHandler *callback,
  50                    void *opaque, Error **errp);
  51 int socket_listen(SocketAddress *addr, Error **errp);
  52 void socket_listen_cleanup(int fd, Error **errp);
  53 int socket_dgram(SocketAddress *remote, SocketAddress *local, Error **errp);
  54
  55 /* Old, ipv4 only bits.  Don't use for new code. */
  56 int parse_host_port(struct sockaddr_in *saddr, const char *str);
  57 int socket_init(void);
  58
  59 /**
  60  * socket_sockaddr_to_address:
  61  * @sa: socket address struct
  62  * @salen: size of @sa struct
  63  * @errp: pointer to uninitialized error object
  64  *
  65  * Get the string representation of the socket
  66  * address. A pointer to the allocated address information
  67  * struct will be returned, which the caller is required to
  68  * release with a call qapi_free_SocketAddress() when no
  69  * longer required.
  70  *
  71  * Returns: the socket address struct, or NULL on error
  72  */
  73 SocketAddress *
  74 socket_sockaddr_to_address(struct sockaddr_storage *sa,
  75                            socklen_t salen,
  76                            Error **errp);
  77
  78 /**
  79  * socket_local_address:
  80  * @fd: the socket file handle
  81  * @errp: pointer to uninitialized error object
  82  *
  83  * Get the string representation of the local socket
  84  * address. A pointer to the allocated address information
  85  * struct will be returned, which the caller is required to
  86  * release with a call qapi_free_SocketAddress() when no
  87  * longer required.
  88  *
  89  * Returns: the socket address struct, or NULL on error
  90  */
  91 SocketAddress *socket_local_address(int fd, Error **errp);
  92
  93 /**
  94  * socket_remote_address:
  95  * @fd: the socket file handle
  96  * @errp: pointer to uninitialized error object
  97  *
  98  * Get the string representation of the remote socket
  99  * address. A pointer to the allocated address information
 100  * struct will be returned, which the caller is required to
 101  * release with a call qapi_free_SocketAddress() when no
 102  * longer required.
 103  *
 104  * Returns: the socket address struct, or NULL on error
 105  */
 106 SocketAddress *socket_remote_address(int fd, Error **errp);
 107
 108 /**
 109  * socket_address_to_string:
 110  * @addr: the socket address struct
 111  * @errp: pointer to uninitialized error object
 112  *
 113  * Get the string representation of the socket
 114  * address. A pointer to the char array containing
 115  * string format will be returned, the caller is
 116  * required to release the returned value when no
 117  * longer required with g_free.
 118  *
 119  * Returns: the socket address in string format, or NULL on error
 120  */
 121 char *socket_address_to_string(struct SocketAddress *addr, Error **errp);
 122
 123 /**
 124  * socket_address_crumple:
 125  * @addr_flat: the socket address to crumple
 126  *
 127  * Convert SocketAddress to SocketAddressLegacy.  Caller is responsible
 128  * for freeing with qapi_free_SocketAddressLegacy().
 129  *
 130  * Returns: the argument converted to SocketAddressLegacy.
 131  */
 132 SocketAddressLegacy *socket_address_crumple(SocketAddress *addr);
 133
 134 /**
 135  * socket_address_flatten:
 136  * @addr: the socket address to flatten
 137  *
 138  * Convert SocketAddressLegacy to SocketAddress.  Caller is responsible
 139  * for freeing with qapi_free_SocketAddress().
 140  *
 141  * Returns: the argument converted to SocketAddress.
 142  */
 143 SocketAddress *socket_address_flatten(SocketAddressLegacy *addr);
 144
 145 #endif /* QEMU_SOCKETS_H */