Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gio.SocketListener
Gio.SocketService
Gio.ThreadedSocketService

Class Gio.ThreadedSocketService

Import line:	Gio = imports.gi.Gio;
GIR File:	Gio-2.0.gir
C documentation:	GThreadedSocketService
Class :	ThreadedSocketService
Extends:	Gio.SocketService

A GThreadedSocketService is a simple subclass of GSocketService
that handles incoming connections by creating a worker thread and
dispatching the connection to it by emitting the ::run signal in
the new thread.
The signal handler may perform blocking IO and need not return
until the connection is closed.
The service is implemented using a thread pool, so there is a
limited amount of threads availible to serve incomming requests.
The service automatically stops the GSocketService from accepting
new connections when all threads are busy.
As with GSocketService, you may connect to GThreadedSocketService:run,
or subclass and override the default handler.

Properties
Properties		Defined By
	listen_backlog : gint32	Gio.SocketListener
	max_threads : gint32	Gio.ThreadedSocketService
	parent_instance : Gio.SocketService read only	Gio.ThreadedSocketService
	priv : Gio.ThreadedSocketServicePrivate read only	Gio.ThreadedSocketService

Methods / Constructors
Method / Constructor		Defined By
	new Gio.ThreadedSocketService (Object *properties) Create a new Gio.ThreadedSocketService Create a new Gio.ThreadedSocketService Parameters: Object properties*
	new Gio.ThreadedSocketService.c_new (gint32 *max_threads) : Gio.SocketService Create a new Gio.ThreadedSocketService Create a new Gio.ThreadedSocketService Parameters: gint32 max_threads* Required (not null) the maximal number of threads to execute concurrently handling incoming clients, -1 means no limit Returns: Gio.SocketService a new GSocketService.
	accept (Object *out_values, Cancellable cancellable) : Gio.SocketConnection Blocks waiting for a client to connect to any of the sockets added to the listener. 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. Parameters: Object out_values GObject.Object source_object Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Returns: Gio.SocketConnection a GSocketConnection on success, NULL on error.	Gio.SocketListener
	accept_async (Cancellable *cancellable, Function callback, void *user_data) : none This is the asynchronous version of g_socket_listener_accept(). This is the asynchronous version of g_socket_listener_accept(). When the operation is finished callback* will be called. You can then call g_socket_listener_accept_socket() to get the result of the operation. Parameters: Gio.Cancellable cancellable a GCancellable, or NULL Function (Object *source_object, AsyncResult res, void *user_data) : none Required (not null) a GAsyncReadyCallback* void* user_data Required (not null) user data for the callback Returns: none	Gio.SocketListener
	accept_finish (AsyncResult *result, Object out_values) : Gio.SocketConnection Finishes an async accept operation. Finishes an async accept operation. See g_socket_listener_accept_async() Parameters: Gio.AsyncResult result* Required (not null) a GAsyncResult. Object out_values GObject.Object source_object Returns: Gio.SocketConnection a GSocketConnection on success, NULL on error.	Gio.SocketListener
	accept_socket (Object *out_values, Cancellable cancellable) : Gio.Socket Blocks waiting for a client to connect to any of the sockets added to the listener. 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. Parameters: Object out_values GObject.Object source_object Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Returns: Gio.Socket a GSocket on success, NULL on error.	Gio.SocketListener
	accept_socket_async (Cancellable *cancellable, Function callback, void *user_data) : none This is the asynchronous version of g_socket_listener_accept_socket(). This is the asynchronous version of g_socket_listener_accept_socket(). When the operation is finished callback* will be called. You can then call g_socket_listener_accept_socket_finish() to get the result of the operation. Parameters: Gio.Cancellable cancellable a GCancellable, or NULL Function (Object *source_object, AsyncResult res, void *user_data) : none Required (not null) a GAsyncReadyCallback* void* user_data Required (not null) user data for the callback Returns: none	Gio.SocketListener
	accept_socket_finish (AsyncResult *result, Object out_values) : Gio.Socket Finishes an async accept operation. Finishes an async accept operation. See g_socket_listener_accept_socket_async() Parameters: Gio.AsyncResult result* Required (not null) a GAsyncResult. Object out_values GObject.Object source_object Returns: Gio.Socket a GSocket on success, NULL on error.	Gio.SocketListener
	add_address (SocketAddress *address, SocketType type, SocketProtocol protocol, Object source_object, Object out_values) : gboolean 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. 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 determinstic behaviour, see g_socket_listener_add_inet_port(). 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 occured at. This is helpful for determining the port number that was used for when requested, belongs to the caller and must be freed. Parameters: Gio.SocketAddress address Required (not null) a GSocketAddress Gio.SocketType type Required (not null) a GSocketType Gio.SocketProtocol protocol Required (not null) a GSocketProtocol GObject.Object source_object Optional GObject identifying this source Object out_values Gio.SocketAddress effective_address Returns: gboolean TRUE on success, FALSE on error.	Gio.SocketListener
	add_any_inet_port (Object *source_object) : guint16 Listens for TCP connections on any available port number for both IPv6 and IPv4 (if each are available). Listens for TCP connections on any available port number for both IPv6 and IPv4 (if each are available). This is useful if you need to have a socket for incoming connections but don't care about the specific port number. 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. Parameters: GObject.Object source_object* Optional GObject identifying this source Returns: guint16 the port number, or 0 in case of failure.	Gio.SocketListener
	add_inet_port (guint16 *port, Object source_object) : gboolean 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. 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. 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. Parameters: guint16 port* Required (not null) an IP port number (non-zero) GObject.Object source_object Optional GObject identifying this source Returns: gboolean TRUE on success, FALSE on error.	Gio.SocketListener
	add_socket (Socket *socket, Object source_object) : gboolean Adds socket* to the set of sockets that we try to accept new clients from. 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. 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. Parameters: Gio.Socket socket Required (not null) a listening GSocket GObject.Object source_object Optional GObject identifying this source Returns: gboolean TRUE on success, FALSE on error.	Gio.SocketListener
	close () : none Closes all the sockets in the listener. Closes all the sockets in the listener. Returns: none	Gio.SocketListener
	is_active () : gboolean Check whether the service is active or not. 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. Returns: gboolean TRUE if the service is active, FALSE otherwise	Gio.SocketService
	set_backlog (gint32 *listen_backlog) : none Sets the listen backlog on the sockets in the listener. Sets the listen backlog on the sockets in the listener. See g_socket_set_listen_backlog() for details Parameters: gint32 listen_backlog* Required (not null) an integer Returns: none	Gio.SocketListener
	start () : none Starts the service, i.e. Starts the service, i.e. start accepting connections from the added sockets when the mainloop runs. This call is threadsafe, so it may be called from a thread handling an incomming client request. Returns: none	Gio.SocketService
	stop () : none Stops the service, i.e. Stops the service, i.e. stops accepting connections from the added sockets when the mainloop runs. This call is threadsafe, so it may be called from a thread handling an incomming client request. Returns: none	Gio.SocketService

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	incoming (SocketService *self, SocketConnection connection, Object source_object) : gboolean The ::incoming signal is emitted when a new incoming connection to service* needs to be handled. 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. Parameters: Gio.SocketService self Gio.SocketConnection connection GObject.Object source_object Returns: {gboolean}	Gio.SocketService
	run (ThreadedSocketService *self, SocketConnection connection, Object source_object) : gboolean The ::run signal is emitted in a worker thread in response to an incoming connection. The ::run signal is emitted in a worker thread in response to an incoming connection. This thread is dedicated to handling not return until the connection is closed. Parameters: Gio.ThreadedSocketService self* Gio.SocketConnection connection GObject.Object source_object Returns: {gboolean}	Gio.ThreadedSocketService