| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gio.Objects.ThreadedSocketService
Description
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
ThreadedSocketService::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 ThreadedSocketService::run,
or subclass and override the default handler.
Since: 2.22
Synopsis
- newtype ThreadedSocketService = ThreadedSocketService (ManagedPtr ThreadedSocketService)
- class (GObject o, IsDescendantOf ThreadedSocketService o) => IsThreadedSocketService o
- toThreadedSocketService :: (MonadIO m, IsThreadedSocketService o) => o -> m ThreadedSocketService
- noThreadedSocketService :: Maybe ThreadedSocketService
- threadedSocketServiceNew :: (HasCallStack, MonadIO m) => Int32 -> m ThreadedSocketService
- constructThreadedSocketServiceMaxThreads :: IsThreadedSocketService o => Int32 -> IO (GValueConstruct o)
- getThreadedSocketServiceMaxThreads :: (MonadIO m, IsThreadedSocketService o) => o -> m Int32
- type C_ThreadedSocketServiceRunCallback = Ptr () -> Ptr SocketConnection -> Ptr Object -> Ptr () -> IO CInt
- type ThreadedSocketServiceRunCallback = SocketConnection -> Object -> IO Bool
- afterThreadedSocketServiceRun :: (IsThreadedSocketService a, MonadIO m) => a -> ThreadedSocketServiceRunCallback -> m SignalHandlerId
- genClosure_ThreadedSocketServiceRun :: MonadIO m => ThreadedSocketServiceRunCallback -> m (GClosure C_ThreadedSocketServiceRunCallback)
- mk_ThreadedSocketServiceRunCallback :: C_ThreadedSocketServiceRunCallback -> IO (FunPtr C_ThreadedSocketServiceRunCallback)
- noThreadedSocketServiceRunCallback :: Maybe ThreadedSocketServiceRunCallback
- onThreadedSocketServiceRun :: (IsThreadedSocketService a, MonadIO m) => a -> ThreadedSocketServiceRunCallback -> m SignalHandlerId
- wrap_ThreadedSocketServiceRunCallback :: ThreadedSocketServiceRunCallback -> C_ThreadedSocketServiceRunCallback
Exported types
newtype ThreadedSocketService Source #
Memory-managed wrapper type.
Constructors
| ThreadedSocketService (ManagedPtr ThreadedSocketService) |
Instances
| GObject ThreadedSocketService Source # | |
Defined in GI.Gio.Objects.ThreadedSocketService Methods gobjectType :: IO GType # | |
| HasParentTypes ThreadedSocketService Source # | |
Defined in GI.Gio.Objects.ThreadedSocketService | |
| type ParentTypes ThreadedSocketService Source # | |
Defined in GI.Gio.Objects.ThreadedSocketService type ParentTypes ThreadedSocketService = SocketService ': (SocketListener ': (Object ': ([] :: [Type]))) | |
class (GObject o, IsDescendantOf ThreadedSocketService o) => IsThreadedSocketService o Source #
Type class for types which can be safely cast to ThreadedSocketService, for instance with toThreadedSocketService.
Instances
| (GObject o, IsDescendantOf ThreadedSocketService o) => IsThreadedSocketService o Source # | |
Defined in GI.Gio.Objects.ThreadedSocketService | |
toThreadedSocketService :: (MonadIO m, IsThreadedSocketService o) => o -> m ThreadedSocketService Source #
Cast to ThreadedSocketService, for types for which this is known to be safe. For general casts, use castTo.
noThreadedSocketService :: Maybe ThreadedSocketService Source #
A convenience alias for Nothing :: Maybe ThreadedSocketService.
Methods
new
threadedSocketServiceNew Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Int32 |
|
| -> m ThreadedSocketService | Returns: a new |
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) Source #
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 Source #
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 Source #
Type for the callback on the (unwrapped) C side.
type ThreadedSocketServiceRunCallback Source #
Arguments
| = SocketConnection |
|
| -> Object |
|
| -> IO Bool | Returns: |
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 Source #
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) Source #
Wrap the callback into a GClosure.
mk_ThreadedSocketServiceRunCallback :: C_ThreadedSocketServiceRunCallback -> IO (FunPtr C_ThreadedSocketServiceRunCallback) Source #
Generate a function pointer callable from C code, from a C_ThreadedSocketServiceRunCallback.
noThreadedSocketServiceRunCallback :: Maybe ThreadedSocketServiceRunCallback Source #
A convenience synonym for Nothing :: Maybe ThreadedSocketServiceRunCallback
onThreadedSocketServiceRun :: (IsThreadedSocketService a, MonadIO m) => a -> ThreadedSocketServiceRunCallback -> m SignalHandlerId Source #
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