Functions
g_socket_listener_add_socket ()
gboolean
g_socket_listener_add_socket (GSocketListener *listener,
GSocket *socket,
GObject *source_object,
GError **error);
Adds socket
to the set of sockets that we try to accept
new clients from. The socket must be bound to a local
address and listened to.
source_object
will be passed out in the various calls
to accept to identify this particular source, which is
useful if you're listening on multiple addresses and do
different things depending on what address is connected to.
The socket
will not be automatically closed when the listener
is finalized
unless the listener held the final reference to the socket. Before GLib 2.42,
the socket
was automatically closed on finalization of the listener
, even
if references to it were held elsewhere.
Returns
TRUE on success, FALSE on error.
Since: 2.22
g_socket_listener_add_address ()
gboolean
g_socket_listener_add_address (GSocketListener *listener,
GSocketAddress *address,
GSocketType type,
GSocketProtocol protocol,
GObject *source_object,
GSocketAddress **effective_address,
GError **error);
Creates a socket of type type
and protocol protocol
, binds
it to address
and adds it to the set of sockets we're accepting
sockets from.
Note that adding an IPv6 address, depending on the platform,
may or may not result in a listener that also accepts IPv4
connections. For more deterministic behavior, see
g_socket_listener_add_inet_port().
source_object
will be passed out in the various calls
to accept to identify this particular source, which is
useful if you're listening on multiple addresses and do
different things depending on what address is connected to.
If successful and effective_address
is non-NULL then it will
be set to the address that the binding actually occurred at. This
is helpful for determining the port number that was used for when
requesting a binding to port 0 (ie: "any port"). This address, if
requested, belongs to the caller and must be freed.
Call g_socket_listener_close() to stop listening on address
; this will not
be done automatically when you drop your final reference to listener
, as
references may be held internally.
Returns
TRUE on success, FALSE on error.
Since: 2.22
g_socket_listener_add_inet_port ()
gboolean
g_socket_listener_add_inet_port (GSocketListener *listener,
guint16 port,
GObject *source_object,
GError **error);
Helper function for g_socket_listener_add_address() that
creates a TCP/IP socket listening on IPv4 and IPv6 (if
supported) on the specified port on all interfaces.
source_object
will be passed out in the various calls
to accept to identify this particular source, which is
useful if you're listening on multiple addresses and do
different things depending on what address is connected to.
Call g_socket_listener_close() to stop listening on port
; this will not
be done automatically when you drop your final reference to listener
, as
references may be held internally.
Returns
TRUE on success, FALSE on error.
Since: 2.22
g_socket_listener_add_any_inet_port ()
guint16
g_socket_listener_add_any_inet_port (GSocketListener *listener,
GObject *source_object,
GError **error);
Listens for TCP connections on any available port number for both
IPv6 and IPv4 (if each is available).
This is useful if you need to have a socket for incoming connections
but don't care about the specific port number.
source_object
will be passed out in the various calls
to accept to identify this particular source, which is
useful if you're listening on multiple addresses and do
different things depending on what address is connected to.
Returns
the port number, or 0 in case of failure.
Since: 2.24
g_socket_listener_accept ()
GSocketConnection *
g_socket_listener_accept (GSocketListener *listener,
GObject **source_object,
GCancellable *cancellable,
GError **error);
Blocks waiting for a client to connect to any of the sockets added
to the listener. Returns a GSocketConnection for the socket that was
accepted.
If source_object
is not NULL it will be filled out with the source
object specified when the corresponding socket or address was added
to the listener.
If cancellable
is not NULL, then the operation can be cancelled by
triggering the cancellable object from another thread. If the operation
was cancelled, the error G_IO_ERROR_CANCELLED will be returned.
Since: 2.22
g_socket_listener_accept_socket ()
GSocket *
g_socket_listener_accept_socket (GSocketListener *listener,
GObject **source_object,
GCancellable *cancellable,
GError **error);
Blocks waiting for a client to connect to any of the sockets added
to the listener. Returns the GSocket that was accepted.
If you want to accept the high-level GSocketConnection, not a GSocket,
which is often the case, then you should use g_socket_listener_accept()
instead.
If source_object
is not NULL it will be filled out with the source
object specified when the corresponding socket or address was added
to the listener.
If cancellable
is not NULL, then the operation can be cancelled by
triggering the cancellable object from another thread. If the operation
was cancelled, the error G_IO_ERROR_CANCELLED will be returned.
Returns
a GSocket on success, NULL on error.
[transfer full]
Since: 2.22
g_socket_listener_close ()
void
g_socket_listener_close (GSocketListener *listener);
Closes all the sockets in the listener.
Since: 2.22