System.Restricted.Worker.Types

Worker can be in one of three states

Uninitialized

Uninitialized worker is a worker that has a name, a socket, possibly WData but has not been forker

Initialized

Initialized worker has an associated forker process.

Active

A worker is active if it's initialized and it's being used a client. Active/inactive workers are managed by a WorkersPool.

Workers

data Worker a

A datatype representing a worker of type a

Constructors

Worker

Fields

workerName :: String

Name of the worker

workerSocket :: FilePath

A filepath to the Unix socket that will be used for communicating with the worker. If the file is already present it will be unliked during the initializatin step

workerLimits :: LimitSettings

Security restrictions for the worker

workerPid :: Maybe ProcessID

'Just pid' if the worker's process ID is pid, Nothing' if the worker is not active/initialized

Instances

Typeable1 Worker

Eq (Worker a)

Show (Worker a)

Generic (Worker a)

Serialize (Worker a)

type RestartWorker m a = Worker a -> m (Worker a)

A worker restarting function

class WorkerData w

Types of data attached to a worker. This might be a configuration file, a size of the packet, session data, etc.

Associated Types

type WData w :: *

Data that saves after restarts

type WMonad w :: * -> *

Monad in which the worker runs

Instances

WorkerData IOWorker

data IOWorker

A simple type of worker that executes IO actions

The definition of the WorkerData instance for IOWorker looks like this:

  instance WorkerData IOWorker where
      type WData IOWorker = ()
      type WMonad IOWorker = IO

Instances

WorkerData IOWorker

Other types

data ProtocolException

An exception type used by Protocol

Constructors

ConversionException String

There has been an error during the conversion step

HandleException IOException

There has been an error while using the handler

Instances

Show ProtocolException

Typeable ProtocolException

Exception ProtocolException

Helper functions

initialized :: Worker a -> Bool

Check whether the worker is initialized