GI.Gio.Objects.ThreadedSocketService

A ThreadedSocketService is a simple subclass of SocketService 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 available to serve incoming requests. The service automatically stops the SocketService from accepting new connections when all threads are busy.

As with SocketService, you may connect to run, or subclass and override the default handler.

Since: 2.22

Exported types

newtype ThreadedSocketService

Memory-managed wrapper type.

Constructors

ThreadedSocketService (ManagedPtr ThreadedSocketService)

Instances

Eq ThreadedSocketService

Defined in GI.Gio.Objects.ThreadedSocketService

Methods

(==) :: ThreadedSocketService -> ThreadedSocketService -> Bool

(/=) :: ThreadedSocketService -> ThreadedSocketService -> Bool

GObject ThreadedSocketService

Defined in GI.Gio.Objects.ThreadedSocketService

Methods

gobjectType :: IO GType

IsGValue ThreadedSocketService

Convert ThreadedSocketService to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Objects.ThreadedSocketService

Methods

toGValue :: ThreadedSocketService -> IO GValue

fromGValue :: GValue -> IO ThreadedSocketService

HasParentTypes ThreadedSocketService

Defined in GI.Gio.Objects.ThreadedSocketService

type ParentTypes ThreadedSocketService

Defined in GI.Gio.Objects.ThreadedSocketService

type ParentTypes ThreadedSocketService = '[SocketService, SocketListener, Object]

class (GObject o, IsDescendantOf ThreadedSocketService o) => IsThreadedSocketService o

Type class for types which can be safely cast to ThreadedSocketService, for instance with toThreadedSocketService.

Instances

(GObject o, IsDescendantOf ThreadedSocketService o) => IsThreadedSocketService o

Defined in GI.Gio.Objects.ThreadedSocketService

toThreadedSocketService :: (MonadIO m, IsThreadedSocketService o) => o -> m ThreadedSocketService

Cast to ThreadedSocketService, for types for which this is known to be safe. For general casts, use castTo.

noThreadedSocketService :: Maybe ThreadedSocketService

A convenience alias for Nothing :: Maybe ThreadedSocketService.

Methods

Overloaded methods

new

threadedSocketServiceNew

Arguments

:: (HasCallStack, MonadIO m)

=> Int32

maxThreads: the maximal number of threads to execute concurrently handling incoming clients, -1 means no limit

-> m ThreadedSocketService

Returns: a new SocketService.

Creates a new ThreadedSocketService with no listeners. Listeners must be added with one of the SocketListener "add" methods.

Since: 2.22

Properties

maxThreads

No description available in the introspection data.

constructThreadedSocketServiceMaxThreads :: IsThreadedSocketService o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “max-threads” property. This is rarely needed directly, but it is used by new.

getThreadedSocketServiceMaxThreads :: (MonadIO m, IsThreadedSocketService o) => o -> m Int32

Get the value of the “max-threads” property. When overloading is enabled, this is equivalent to

get threadedSocketService #maxThreads

Signals

run

type C_ThreadedSocketServiceRunCallback = Ptr () -> Ptr SocketConnection -> Ptr Object -> Ptr () -> IO CInt

Type for the callback on the (unwrapped) C side.

type ThreadedSocketServiceRunCallback

Arguments

 = SocketConnection

connection: a new SocketConnection object.

-> Object

sourceObject: the source_object passed to socketListenerAddAddress.

-> IO Bool

Returns: True to stop further signal handlers from being called

The run signal is emitted in a worker thread in response to an incoming connection. This thread is dedicated to handling connection and may perform blocking IO. The signal handler need not return until the connection is closed.

afterThreadedSocketServiceRun :: (IsThreadedSocketService a, MonadIO m) => a -> ThreadedSocketServiceRunCallback -> m SignalHandlerId

Connect a signal handler for the run signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after threadedSocketService #run callback

genClosure_ThreadedSocketServiceRun :: MonadIO m => ThreadedSocketServiceRunCallback -> m (GClosure C_ThreadedSocketServiceRunCallback)

Wrap the callback into a GClosure.

mk_ThreadedSocketServiceRunCallback :: C_ThreadedSocketServiceRunCallback -> IO (FunPtr C_ThreadedSocketServiceRunCallback)

Generate a function pointer callable from C code, from a C_ThreadedSocketServiceRunCallback.

noThreadedSocketServiceRunCallback :: Maybe ThreadedSocketServiceRunCallback

A convenience synonym for Nothing :: Maybe ThreadedSocketServiceRunCallback.

onThreadedSocketServiceRun :: (IsThreadedSocketService a, MonadIO m) => a -> ThreadedSocketServiceRunCallback -> m SignalHandlerId

Connect a signal handler for the run signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on threadedSocketService #run callback

wrap_ThreadedSocketServiceRunCallback :: ThreadedSocketServiceRunCallback -> C_ThreadedSocketServiceRunCallback

Wrap a ThreadedSocketServiceRunCallback into a C_ThreadedSocketServiceRunCallback.