include/io/net-listener.h

   1 /*
   2  * QEMU network listener
   3  *
   4  * Copyright (c) 2016-2017 Red Hat, Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, see <http://www.gnu.org/licenses/>.
  18  *
  19  */
  20
  21 #ifndef QIO_NET_LISTENER_H
  22 #define QIO_NET_LISTENER_H
  23
  24 #include "io/channel-socket.h"
  25
  26 #define TYPE_QIO_NET_LISTENER "qio-net-listener"
  27 #define QIO_NET_LISTENER(obj)                                    \
  28     OBJECT_CHECK(QIONetListener, (obj), TYPE_QIO_NET_LISTENER)
  29 #define QIO_NET_LISTENER_CLASS(klass)                                    \
  30     OBJECT_CLASS_CHECK(QIONetListenerClass, klass, TYPE_QIO_NET_LISTENER)
  31 #define QIO_NET_LISTENER_GET_CLASS(obj)                                  \
  32     OBJECT_GET_CLASS(QIONetListenerClass, obj, TYPE_QIO_NET_LISTENER)
  33
  34 typedef struct QIONetListener QIONetListener;
  35 typedef struct QIONetListenerClass QIONetListenerClass;
  36
  37 typedef void (*QIONetListenerClientFunc)(QIONetListener *listener,
  38                                          QIOChannelSocket *sioc,
  39                                          gpointer data);
  40
  41 /**
  42  * QIONetListener:
  43  *
  44  * The QIONetListener object encapsulates the management of a
  45  * listening socket. It is able to listen on multiple sockets
  46  * concurrently, to deal with the scenario where IPv4 / IPv6
  47  * needs separate sockets, or there is a need to listen on a
  48  * subset of interface IP addresses, instead of the wildcard
  49  * address.
  50  */
  51 struct QIONetListener {
  52     Object parent;
  53
  54     char *name;
  55     QIOChannelSocket **sioc;
  56     gulong *io_tag;
  57     size_t nsioc;
  58
  59     bool connected;
  60
  61     QIONetListenerClientFunc io_func;
  62     gpointer io_data;
  63     GDestroyNotify io_notify;
  64 };
  65
  66 struct QIONetListenerClass {
  67     ObjectClass parent;
  68 };
  69
  70
  71 /**
  72  * qio_net_listener_new:
  73  *
  74  * Create a new network listener service, which is not
  75  * listening on any sockets initially.
  76  *
  77  * Returns: the new listener
  78  */
  79 QIONetListener *qio_net_listener_new(void);
  80
  81
  82 /**
  83  * qio_net_listener_set_name:
  84  * @listener: the network listener object
  85  * @name: the listener name
  86  *
  87  * Set the name of the listener. This is used as a debugging
  88  * aid, to set names on any GSource instances associated
  89  * with the listener
  90  */
  91 void qio_net_listener_set_name(QIONetListener *listener,
  92                                const char *name);
  93
  94 /**
  95  * qio_net_listener_open_sync:
  96  * @listener: the network listener object
  97  * @addr: the address to listen on
  98  * @errp: pointer to a NULL initialized error object
  99  *
 100  * Synchronously open a listening connection on all
 101  * addresses associated with @addr. This method may
 102  * also be invoked multiple times, in order to have a
 103  * single listener on multiple distinct addresses.
 104  */
 105 int qio_net_listener_open_sync(QIONetListener *listener,
 106                                SocketAddress *addr,
 107                                Error **errp);
 108
 109 /**
 110  * qio_net_listener_add:
 111  * @listener: the network listener object
 112  * @sioc: the socket I/O channel
 113  *
 114  * Associate a listening socket I/O channel with the
 115  * listener. The listener will acquire a new reference
 116  * on @sioc, so the caller should release its own reference
 117  * if it no longer requires the object.
 118  */
 119 void qio_net_listener_add(QIONetListener *listener,
 120                           QIOChannelSocket *sioc);
 121
 122 /**
 123  * qio_net_listener_set_client_func:
 124  * @listener: the network listener object
 125  * @func: the callback function
 126  * @data: opaque data to pass to @func
 127  * @notify: callback to free @data
 128  *
 129  * Register @func to be invoked whenever a new client
 130  * connects to the listener. @func will be invoked
 131  * passing in the QIOChannelSocket instance for the
 132  * client.
 133  */
 134 void qio_net_listener_set_client_func(QIONetListener *listener,
 135                                       QIONetListenerClientFunc func,
 136                                       gpointer data,
 137                                       GDestroyNotify notify);
 138
 139 /**
 140  * qio_net_listener_wait_client:
 141  * @listener: the network listener object
 142  *
 143  * Block execution of the caller until a new client arrives
 144  * on one of the listening sockets. If there was previously
 145  * a callback registered with qio_net_listener_set_client_func
 146  * it will be temporarily disabled, and re-enabled afterwards.
 147  *
 148  * Returns: the new client socket
 149  */
 150 QIOChannelSocket *qio_net_listener_wait_client(QIONetListener *listener);
 151
 152
 153 /**
 154  * qio_net_listener_disconnect:
 155  * @listener: the network listener object
 156  *
 157  * Disconnect the listener, removing all I/O callback
 158  * watches and closing the socket channels.
 159  */
 160 void qio_net_listener_disconnect(QIONetListener *listener);
 161
 162
 163 /**
 164  * qio_net_listener_is_connected:
 165  * @listener: the network listener object
 166  *
 167  * Determine if the listener is connected to any socket
 168  * channels
 169  *
 170  * Returns: true if connected, false otherwise
 171  */
 172 bool qio_net_listener_is_connected(QIONetListener *listener);
 173
 174 #endif /* QIO_NET_LISTENER_H */