Class

GioSocketService

Description [src]

class Gio.SocketService : Gio.SocketListener {
  parent_instance: GSocketListener,
  priv: GSocketServicePrivate*
}

A GSocketService is an object that represents a service that is provided to the network or over local sockets. When a new connection is made to the service the GSocketService::incoming signal is emitted.

A GSocketService is a subclass of GSocketListener and you need to add the addresses you want to accept connections on with the GSocketListener APIs.

There are two options for implementing a network service based on GSocketService. The first is to create the service using g_socket_service_new() and to connect to the GSocketService::incoming signal. The second is to subclass GSocketService and override the default signal handler implementation.

In either case, the handler must immediately return, or else it will block additional incoming connections from being serviced. If you are interested in writing connection handlers that contain blocking code then see GThreadedSocketService.

The socket service runs on the main loop of the [thread-default context][g-main-context-push-thread-default-context] of the thread it is created in, and is not threadsafe in general. However, the calls to start and stop the service are thread-safe so these can be used from threads that handle incoming clients.

Available since:2.22

Hierarchy

hierarchy this GSocketService ancestor_0 GSocketListener ancestor_0--this ancestor_1 GObject ancestor_1--ancestor_0

Constructors

g_socket_service_new

Creates a new GSocketService with no sockets to listen for. New listeners can be added with e.g. g_socket_listener_add_address() or g_socket_listener_add_inet_port().

Available since: 2.22

Instance methods

g_socket_service_is_active

Check whether the service is active or not. An active service will accept new clients that connect, while a non-active service will let connecting clients queue up until the service is started.

Available since: 2.22

g_socket_service_start

Restarts the service, i.e. start accepting connections from the added sockets when the mainloop runs. This only needs to be called after the service has been stopped from g_socket_service_stop().

Available since: 2.22

g_socket_service_stop

Stops the service, i.e. stops accepting connections from the added sockets when the mainloop runs.

Available since: 2.22

Methods inherited from GSocketListener (12)
g_socket_listener_accept

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.

Available since: 2.22

g_socket_listener_accept_async

This is the asynchronous version of g_socket_listener_accept().

Available since: 2.22

g_socket_listener_accept_finish

Finishes an async accept operation. See g_socket_listener_accept_async()

Available since: 2.22

g_socket_listener_accept_socket

Blocks waiting for a client to connect to any of the sockets added to the listener. Returns the GSocket that was accepted.

Available since: 2.22

g_socket_listener_accept_socket_async

This is the asynchronous version of g_socket_listener_accept_socket().

Available since: 2.22

g_socket_listener_accept_socket_finish

Finishes an async accept operation. See g_socket_listener_accept_socket_async()

Available since: 2.22

g_socket_listener_add_address

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.

Available since: 2.22

g_socket_listener_add_any_inet_port

Listens for TCP connections on any available port number for both IPv6 and IPv4 (if each is available).

Available since: 2.24

g_socket_listener_add_inet_port

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.

Available since: 2.22

g_socket_listener_add_socket

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.

Available since: 2.22

g_socket_listener_close

Closes all the sockets in the listener.

Available since: 2.22

g_socket_listener_set_backlog

Sets the listen backlog on the sockets in the listener. This must be called before adding any sockets, addresses or ports to the GSocketListener (for example, by calling g_socket_listener_add_inet_port()) to be effective.

Available since: 2.22

Methods inherited from GObject (43)

Properties

Gio.SocketService:active

Whether the service is currently accepting connections.

Available since: 2.46

Properties inherited from GSocketListener (1)
Gio.SocketListener:listen-backlog
No description available.

Signals

Gio.SocketService::incoming

The ::incoming signal is emitted when a new incoming connection to service needs to be handled. The handler must initiate the handling of connection, but may not block; in essence, asynchronous operations must be used.

Available since: 2.22

Signals inherited from GSocketListener (1)
Gio.SocketListener::event

Emitted when listeners activity on socket changes state. Note that when listener is used to listen on both IPv4 and IPv6, a separate set of signals will be emitted for each, and the order they happen in is undefined.

Available since: 2.46

Signals inherited from GObject (1)

Class structure

struct GioSocketServiceClass {
  GSocketListenerClass parent_class;
  gboolean (* incoming) (
    GSocketService* service,
    GSocketConnection* connection,
    GObject* source_object
  );
  void (* _g_reserved1) (
void
  );
  void (* _g_reserved2) (
void
  );
  void (* _g_reserved3) (
void
  );
  void (* _g_reserved4) (
void
  );
  void (* _g_reserved5) (
void
  );
  void (* _g_reserved6) (
void
  );
  
}
Class members
parent_class
GSocketListenerClass
  No description available.
incoming
gboolean (* incoming) (
    GSocketService* service,
    GSocketConnection* connection,
    GObject* source_object
  )
  No description available.
_g_reserved1
void (* _g_reserved1) (
void
  )
  No description available.
_g_reserved2
void (* _g_reserved2) (
void
  )
  No description available.
_g_reserved3
void (* _g_reserved3) (
void
  )
  No description available.
_g_reserved4
void (* _g_reserved4) (
void
  )
  No description available.
_g_reserved5
void (* _g_reserved5) (
void
  )
  No description available.
_g_reserved6
void (* _g_reserved6) (
void
  )
  No description available.

Virtual methods

Gio.SocketServiceClass.incoming
No description available.