gio/org.gtkkn.bindings.gio/SocketService

SocketService

open class SocketService(pointer: <Error class: unknown class><<Error class: unknown class>>) : SocketListener

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 signal@Gio.SocketService::incoming signal is emitted.

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

There are two options for implementing a network service based on GSocketService. The first is to create the service using ctor@Gio.SocketService.new and to connect to the signal@Gio.SocketService::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 class@Gio.ThreadedSocketService.

The socket service runs on the main loop of the thread-default context (see method@GLib.MainContext.push_thread_default) 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.

Skipped during bindings generation

method active: Property has no getter nor setter

Since

2.22

Inheritors

ThreadedSocketService

Constructors

SocketService

constructor()

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().

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gioSocketListenerPointer

val gioSocketListenerPointer: <Error class: unknown class><<Error class: unknown class>>

gioSocketServicePointer

val gioSocketServicePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

acceptAsync

open fun acceptAsync(cancellable: Cancellable? = null, callback: AsyncReadyCallback)

This is the asynchronous version of g_socket_listener_accept().

acceptSocketAsync

open fun acceptSocketAsync(cancellable: Cancellable? = null, callback: AsyncReadyCallback)

This is the asynchronous version of g_socket_listener_accept_socket().

addAnyInetPort

open fun addAnyInetPort(sourceObject: <Error class: unknown class>? = null): <Error class: unknown class><<Error class: unknown class>>

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

addInetPort

open fun addInetPort(port: <Error class: unknown class>, sourceObject: <Error class: unknown class>? = null): <Error class: unknown class><Boolean>

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.

addSocket

open fun addSocket(socket: Socket, sourceObject: <Error class: unknown class>? = null): <Error class: unknown class><Boolean>

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.

open fun close()

Closes all the sockets in the listener.

connectEvent

fun connectEvent(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (event: SocketListenerEvent, socket: Socket) -> Unit): <Error class: unknown class>

Emitted when @listener's 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.

connectIncoming

fun connectIncoming(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (connection: SocketConnection, <Error class: unknown class>?) -> Boolean): <Error class: unknown class>

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.

isActive

open fun isActive(): Boolean

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.

setBacklog

open fun setBacklog(listenBacklog: Int)

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.

start

open fun 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().

stop

open fun stop()

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