Control.Eff.Concurrent.Protocol.Server

A better, more safe implementation of the Erlang/OTP gen_server behaviour.

Since: 0.24.0

Documentation

class Typeable (Protocol a) => Server (a :: Type) e where

A type class for Pdu values that have an implementation which handles the corresponding protocol.

Since: 0.24.0

Minimal complete definition

update

Associated Types

data StartArgument a e

The value that defines what is required to initiate a Server loop.

type Protocol a :: Type

The index type of the Events that this server processes. This is the first parameter to the Request and therefore of the Pdu family.

type Model a :: Type

Type of the model data, given to every invocation of update via the ModelState effect. The model of a server loop is changed through incoming Events. It is initially calculated by setup.

type Settings a :: Type

Type of read-only state.

Methods

setup :: StartArgument a e -> Eff e (Model a, Settings a)

setup :: (Default (Model a), Default (Settings a)) => StartArgument a e -> Eff e (Model a, Settings a)

update :: StartArgument a e -> Event (Protocol a) -> Eff (ToServerEffects a e) ()

Instances

(TangibleObserver o, TangiblePdu (Observer o) Asynchronous, Lifted IO q, Member Logs q) => Server (ObservationQueue o) (InterruptableProcess q)

Defined in Control.Eff.Concurrent.Protocol.Observer.Queue

Associated Types

data StartArgument (ObservationQueue o) (InterruptableProcess q) :: Type

type Protocol (ObservationQueue o) :: Type

type Model (ObservationQueue o) :: Type

type Settings (ObservationQueue o) :: Type

Methods

setup :: StartArgument (ObservationQueue o) (InterruptableProcess q) -> Eff (InterruptableProcess q) (Model (ObservationQueue o), Settings (ObservationQueue o))

update :: StartArgument (ObservationQueue o) (InterruptableProcess q) -> Event (Protocol (ObservationQueue o)) -> Eff (ToServerEffects (ObservationQueue o) (InterruptableProcess q)) ()

(Typeable (GenServerProtocol tag), LogIo e) => Server (GenServer tag e) (InterruptableProcess e)

Defined in Control.Eff.Concurrent.Protocol.Server

Associated Types

data StartArgument (GenServer tag e) (InterruptableProcess e) :: Type

type Protocol (GenServer tag e) :: Type

type Model (GenServer tag e) :: Type

type Settings (GenServer tag e) :: Type

Methods

setup :: StartArgument (GenServer tag e) (InterruptableProcess e) -> Eff (InterruptableProcess e) (Model (GenServer tag e), Settings (GenServer tag e))

update :: StartArgument (GenServer tag e) (InterruptableProcess e) -> Event (Protocol (GenServer tag e)) -> Eff (ToServerEffects (GenServer tag e) (InterruptableProcess e)) ()

(Lifted IO q, LogsTo IO q, TangibleSup p, Tangible (ChildId p), Server p (InterruptableProcess q)) => Server (Sup p) (InterruptableProcess q)

Defined in Control.Eff.Concurrent.Protocol.Supervisor

Associated Types

data StartArgument (Sup p) (InterruptableProcess q) :: Type

type Protocol (Sup p) :: Type

type Model (Sup p) :: Type

type Settings (Sup p) :: Type

Methods

setup :: StartArgument (Sup p) (InterruptableProcess q) -> Eff (InterruptableProcess q) (Model (Sup p), Settings (Sup p))

update :: StartArgument (Sup p) (InterruptableProcess q) -> Event (Protocol (Sup p)) -> Eff (ToServerEffects (Sup p) (InterruptableProcess q)) ()

type ToServerEffects a e = ModelState a ': (SettingsReader a ': e)

Cons (i.e. prepend) ModelState and SettingsReader to an effect list.

Since: 0.24.0

type ModelState a = State (Model a)

The Effect type of mutable Model in a Server instance.

Since: 0.24.0

modifyModel :: forall a e. Member (ModelState a) e => (Model a -> Model a) -> Eff e ()

Modify the Model of a Server.

Since: 0.24.0

getAndModifyModel :: forall a e. Member (ModelState a) e => (Model a -> Model a) -> Eff e (Model a)

Modify the Model of a Server and return the old value.

Since: 0.24.0

modifyAndGetModel :: forall a e. Member (ModelState a) e => (Model a -> Model a) -> Eff e (Model a)

Modify the Model of a Server and return the new value.

Since: 0.24.0

getModel :: forall a e. Member (ModelState a) e => Eff e (Model a)

Return the Model of a Server.

Since: 0.24.0

putModel :: forall a e. Member (ModelState a) e => Model a -> Eff e ()

Overwrite the Model of a Server.

Since: 0.24.0

getAndPutModel :: forall a e. Member (ModelState a) e => Model a -> Eff e (Model a)

Overwrite the Model of a Server, return the old value.

Since: 0.24.0

useModel :: forall a b e. Member (ModelState a) e => Getting b (Model a) b -> Eff e b

Return a element selected by a Lens of the Model of a Server.

Since: 0.24.0

zoomModel :: forall a b c e. Member (ModelState a) e => Lens' (Model a) b -> Eff (State b ': e) c -> Eff e c

Run an action that modifies portions of the Model of a Server defined by the given Lens.

Since: 0.24.0

type SettingsReader a = Reader (Settings a)

The Effect type of readonly Settings in a Server instance.

Since: 0.24.0

askSettings :: forall a e. Member (SettingsReader a) e => Eff e (Settings a)

Return the read-only Settings of a Server

Since: 0.24.0

viewSettings :: forall a b e. Member (SettingsReader a) e => Getting b (Settings a) b -> Eff e b

Return the read-only Settings of a Server as viewed through a Lens

Since: 0.24.0

data Event a

Internal protocol to communicate incoming messages and other events to the instances of Server.

Note that this is required to receive any kind of messages in protocolServerLoop.

Since: 0.24.0

Constructors

OnRequest (Request a)

OnInterrupt (Interrupt Recoverable)

OnDown ProcessDown

OnTimeOut TimerElapsed

OnMessage StrictDynamic

Instances

Show (Event a)

Defined in Control.Eff.Concurrent.Protocol.Server

Methods

showsPrec :: Int -> Event a -> ShowS

show :: Event a -> String

showList :: [Event a] -> ShowS

Generic (Event a)

Defined in Control.Eff.Concurrent.Protocol.Server

Associated Types

type Rep (Event a) :: Type -> Type

Methods

from :: Event a -> Rep (Event a) x

to :: Rep (Event a) x -> Event a

NFData a => NFData (Event a)

Defined in Control.Eff.Concurrent.Protocol.Server

Methods

rnf :: Event a -> ()

type Rep (Event a)

Defined in Control.Eff.Concurrent.Protocol.Server

type Rep (Event a) = D1 (MetaData "Event" "Control.Eff.Concurrent.Protocol.Server" "extensible-effects-concurrent-0.24.0-BtHlQYoXrWzBKtecAAHdT4" False) ((C1 (MetaCons "OnRequest" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Request a))) :+: C1 (MetaCons "OnInterrupt" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Interrupt Recoverable)))) :+: (C1 (MetaCons "OnDown" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProcessDown)) :+: (C1 (MetaCons "OnTimeOut" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TimerElapsed)) :+: C1 (MetaCons "OnMessage" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 StrictDynamic)))))

type ToPretty (Event a :: Type)

Defined in Control.Eff.Concurrent.Protocol.Server

type ToPretty (Event a :: Type) = ToPretty a <+> PutStr "event"

start :: forall a q h. (Server a (InterruptableProcess q), Typeable a, LogsTo h (InterruptableProcess q), HasCallStack) => StartArgument a (InterruptableProcess q) -> Eff (InterruptableProcess q) (Endpoint (Protocol a))

Execute the server loop.

Since: 0.24.0

startLink :: forall a q h. (Typeable a, Server a (InterruptableProcess q), LogsTo h (InterruptableProcess q), HasCallStack) => StartArgument a (InterruptableProcess q) -> Eff (InterruptableProcess q) (Endpoint (Protocol a))

Execute the server loop.

Since: 0.24.0

protocolServerLoop :: forall q e h a. (Server a e, SetMember Process (Process q) e, Member Interrupts e, LogsTo h e, Typeable a) => StartArgument a e -> Eff e ()

Execute the server loop.

Since: 0.24.0

data GenServer tag e where

A helper for Servers that are directly based on logging and IO: GenIO

A record that contains callbacks to provide a Server instance for the tag parameter, .

The name prefix Gen indicates the inspiration from Erlang's gen_server module.

Since: 0.24.0

Constructors

MkGenServer

Fields

• :: LogIo e
• => { _setupCallback :: Eff (InterruptableProcess e) (Model (GenServer tag e), Settings (GenServer tag e))
•    , _updateCallback :: Event (GenServerProtocol tag) -> Eff (ToGenServerEffects tag e) ()
•    } -> GenServer tag e

Instances

Typeable tag => Show (StartArgument (GenServer tag e) (InterruptableProcess e))

Defined in Control.Eff.Concurrent.Protocol.Server

Methods

showsPrec :: Int -> StartArgument (GenServer tag e) (InterruptableProcess e) -> ShowS

show :: StartArgument (GenServer tag e) (InterruptableProcess e) -> String

showList :: [StartArgument (GenServer tag e) (InterruptableProcess e)] -> ShowS

NFData (StartArgument (GenServer tag e) (InterruptableProcess e))

Defined in Control.Eff.Concurrent.Protocol.Server

Methods

rnf :: StartArgument (GenServer tag e) (InterruptableProcess e) -> ()

(Typeable (GenServerProtocol tag), LogIo e) => Server (GenServer tag e) (InterruptableProcess e)

Defined in Control.Eff.Concurrent.Protocol.Server

Associated Types

data StartArgument (GenServer tag e) (InterruptableProcess e) :: Type

type Protocol (GenServer tag e) :: Type

type Model (GenServer tag e) :: Type

type Settings (GenServer tag e) :: Type

Methods

setup :: StartArgument (GenServer tag e) (InterruptableProcess e) -> Eff (InterruptableProcess e) (Model (GenServer tag e), Settings (GenServer tag e))

update :: StartArgument (GenServer tag e) (InterruptableProcess e) -> Event (Protocol (GenServer tag e)) -> Eff (ToServerEffects (GenServer tag e) (InterruptableProcess e)) ()

type Protocol (GenServer tag e)

Defined in Control.Eff.Concurrent.Protocol.Server

type Protocol (GenServer tag e) = GenServerProtocol tag

type Model (GenServer tag e)

Defined in Control.Eff.Concurrent.Protocol.Server

type Model (GenServer tag e) = GenServerModel tag

type Settings (GenServer tag e)

Defined in Control.Eff.Concurrent.Protocol.Server

type Settings (GenServer tag e) = GenServerSettings tag

data StartArgument (GenServer tag e) (InterruptableProcess e)

Defined in Control.Eff.Concurrent.Protocol.Server

data StartArgument (GenServer tag e) (InterruptableProcess e) = MkGenStartArgument {

• _genServerId :: GenServerId tag
• _genServerCallbacks :: GenServer tag e

}

type ToGenServerEffects tag e = ToServerEffects (GenServer tag e) (InterruptableProcess e)

Prepend the ModelState for GenServerModel and SettingsReader for GenServerSettings of a GenServer Server to an effect list.

Since: 0.24.0

newtype GenServerId tag

The name/id of a GenServer for logging purposes.

Since: 0.24.0

Constructors

MkGenServerId

Fields

• _fromGenServerId :: Text

Instances

Eq (GenServerId tag)

Defined in Control.Eff.Concurrent.Protocol.Server

Methods

(==) :: GenServerId tag -> GenServerId tag -> Bool

(/=) :: GenServerId tag -> GenServerId tag -> Bool

Ord (GenServerId tag)

Defined in Control.Eff.Concurrent.Protocol.Server

Methods

compare :: GenServerId tag -> GenServerId tag -> Ordering

(<) :: GenServerId tag -> GenServerId tag -> Bool

(<=) :: GenServerId tag -> GenServerId tag -> Bool

(>) :: GenServerId tag -> GenServerId tag -> Bool

(>=) :: GenServerId tag -> GenServerId tag -> Bool

max :: GenServerId tag -> GenServerId tag -> GenServerId tag

min :: GenServerId tag -> GenServerId tag -> GenServerId tag

Show (GenServerId tag)

Defined in Control.Eff.Concurrent.Protocol.Server

Methods

showsPrec :: Int -> GenServerId tag -> ShowS

show :: GenServerId tag -> String

showList :: [GenServerId tag] -> ShowS

IsString (GenServerId tag)

Defined in Control.Eff.Concurrent.Protocol.Server

Methods

fromString :: String -> GenServerId tag

NFData (GenServerId tag)

Defined in Control.Eff.Concurrent.Protocol.Server

Methods

rnf :: GenServerId tag -> ()

type family GenServerProtocol tag

The Protocol un-wrapper type function.

Since: 0.24.0

Instances

type GenServerProtocol (Stateless tag)

Defined in Control.Eff.Concurrent.Protocol.Server

type GenServerProtocol (Stateless tag) = GenServerProtocol tag

type family GenServerModel tag

Type of state for GenServer based Servers

Since: 0.24.0

Instances

type GenServerModel (Stateless tag)

Defined in Control.Eff.Concurrent.Protocol.Server

type GenServerModel (Stateless tag) = ()

type family GenServerSettings tag

Type of the environment for GenServer based Servers

Since: 0.24.0

Instances

type GenServerSettings (Stateless tag)

Defined in Control.Eff.Concurrent.Protocol.Server

type GenServerSettings (Stateless tag) = ()

genServer :: forall tag e. (Typeable tag, HasCallStack, LogIo e, Server (GenServer tag e) (InterruptableProcess e)) => (GenServerId tag -> Eff (InterruptableProcess e) (GenServerModel tag, GenServerSettings tag)) -> (GenServerId tag -> Event (GenServerProtocol tag) -> Eff (ToGenServerEffects tag e) ()) -> GenServerId tag -> StartArgument (GenServer tag e) (InterruptableProcess e)

Create a GenServer.

This requires the callback for Events, a initial Model and a GenServerId.

There must be a GenServerModel instance. There must be a GenServerSettings instance. There must be a GenServerProtocol instance.

This is Haskell, so if this functions is partially applied to some Event callback, you get a function back, that generates StartArguments from GenServerIds, like a factory

Since: 0.24.0

data Stateless tag

The type-level tag indicating a stateless Server instance.

There are GenServerModel, GenServerSettings and GenServerProtocol as well as ToPretty instances for this type.

See also ToStatelessEffects.

Since: 0.24.0

Instances

type ToPretty (Stateless t :: Type)

Defined in Control.Eff.Concurrent.Protocol.Server

type ToPretty (Stateless t :: Type) = ToPretty t

type GenServerSettings (Stateless tag)

Defined in Control.Eff.Concurrent.Protocol.Server

type GenServerSettings (Stateless tag) = ()

type GenServerModel (Stateless tag)

Defined in Control.Eff.Concurrent.Protocol.Server

type GenServerModel (Stateless tag) = ()

type GenServerProtocol (Stateless tag)

Defined in Control.Eff.Concurrent.Protocol.Server

type GenServerProtocol (Stateless tag) = GenServerProtocol tag

type ToStatelessEffects e = State () ': (Reader () ': e)

Prepend the ModelState and SettingsReader of a Stateless Server to an effect list. The Model and Settings of a Stateless Server are just () unit.

Since: 0.24.0

statelessGenServer :: forall tag e. (Typeable tag, HasCallStack, LogIo e, Typeable tag, Server (GenServer (Stateless tag) e) (InterruptableProcess e)) => (GenServerId tag -> Event (GenServerProtocol tag) -> Eff (ToStatelessEffects (InterruptableProcess e)) ()) -> GenServerId tag -> StartArgument (GenServer (Stateless tag) e) (InterruptableProcess e)

Create a Stateless GenServer.

This requires only the callback for Events and a GenServerId.

This is Haskell, so if this functions is partially applied to some Event callback, you get a function back, that generates StartArguments from GenServerIds, like a factory

Since: 0.24.0

Re-exports

data Request protocol where

A wrapper sum type for calls and casts for the Pdus of a protocol

Since: 0.15.0

Constructors

Call :: forall protocol reply. (Tangible reply, TangiblePdu protocol (Synchronous reply)) => RequestOrigin protocol reply -> Pdu protocol (Synchronous reply) -> Request protocol

Cast :: forall protocol. TangiblePdu protocol Asynchronous => Pdu protocol Asynchronous -> Request protocol

Instances

Show (Request protocol)

Defined in Control.Eff.Concurrent.Protocol.Request

Methods

showsPrec :: Int -> Request protocol -> ShowS

show :: Request protocol -> String

showList :: [Request protocol] -> ShowS

NFData (Request protocol)

Defined in Control.Eff.Concurrent.Protocol.Request

Methods

rnf :: Request protocol -> ()

sendReply :: (SetMember Process (Process q) eff, Member Interrupts eff, Tangible reply, Typeable protocol) => RequestOrigin protocol reply -> reply -> Eff eff ()

Send a Reply to a Call.

The reply will be deeply evaluated to rnf.

Since: 0.15.0

data RequestOrigin (proto :: Type) reply

Wraps the source ProcessId and a unique identifier for a Call.

Since: 0.15.0

Constructors

RequestOrigin

Fields

• _requestOriginPid :: !ProcessId
• _requestOriginCallRef :: !Int

Instances

Eq (RequestOrigin proto reply)

Defined in Control.Eff.Concurrent.Protocol.Request

Methods

(==) :: RequestOrigin proto reply -> RequestOrigin proto reply -> Bool

(/=) :: RequestOrigin proto reply -> RequestOrigin proto reply -> Bool

Ord (RequestOrigin proto reply)

Defined in Control.Eff.Concurrent.Protocol.Request

Methods

compare :: RequestOrigin proto reply -> RequestOrigin proto reply -> Ordering

(<) :: RequestOrigin proto reply -> RequestOrigin proto reply -> Bool

(<=) :: RequestOrigin proto reply -> RequestOrigin proto reply -> Bool

(>) :: RequestOrigin proto reply -> RequestOrigin proto reply -> Bool

(>=) :: RequestOrigin proto reply -> RequestOrigin proto reply -> Bool

max :: RequestOrigin proto reply -> RequestOrigin proto reply -> RequestOrigin proto reply

min :: RequestOrigin proto reply -> RequestOrigin proto reply -> RequestOrigin proto reply

Show (RequestOrigin p r)

Defined in Control.Eff.Concurrent.Protocol.Request

Methods

showsPrec :: Int -> RequestOrigin p r -> ShowS

show :: RequestOrigin p r -> String

showList :: [RequestOrigin p r] -> ShowS

Generic (RequestOrigin proto reply)

Defined in Control.Eff.Concurrent.Protocol.Request

Associated Types

type Rep (RequestOrigin proto reply) :: Type -> Type

Methods

from :: RequestOrigin proto reply -> Rep (RequestOrigin proto reply) x

to :: Rep (RequestOrigin proto reply) x -> RequestOrigin proto reply

NFData (RequestOrigin p r)

Defined in Control.Eff.Concurrent.Protocol.Request

Methods

rnf :: RequestOrigin p r -> ()

type Rep (RequestOrigin proto reply)

Defined in Control.Eff.Concurrent.Protocol.Request

type Rep (RequestOrigin proto reply) = D1 (MetaData "RequestOrigin" "Control.Eff.Concurrent.Protocol.Request" "extensible-effects-concurrent-0.24.0-BtHlQYoXrWzBKtecAAHdT4" False) (C1 (MetaCons "RequestOrigin" PrefixI True) (S1 (MetaSel (Just "_requestOriginPid") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ProcessId) :*: S1 (MetaSel (Just "_requestOriginCallRef") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))