Safe Haskell | None |
---|---|
Language | Haskell2010 |
This module contains a mechanism to specify what kind of messages (aka
requests) a Endpoint
(Process
) can handle, and if the caller blocks and
waits for an answer, which the server process provides.
The type magic in the Pdu
type family allows to define a related set of requests along
with the corresponding responses.
Request handling can be either blocking, if a response is required, or non-blocking.
A process can serve a specific Pdu
instance by using the functions provided by
the Control.Eff.Concurrent.Pdu.Server module.
To enable a process to use such a service, the functions provided by the Control.Eff.Concurrent.Pdu.Client should be used.
Synopsis
- class (NFData (Pdu protocol reply), Show (Pdu protocol reply), Typeable protocol, Typeable reply) => IsPdu (protocol :: Type) (reply :: Synchronicity) where
- data Pdu protocol reply
- deserializePdu :: Dynamic -> Maybe (Pdu protocol reply)
- data Synchronicity
- type family ProtocolReply (s :: Synchronicity) where ...
- type Tangible i = (NFData i, Typeable i, Show i)
- type TangiblePdu p r = (Typeable p, Typeable r, Tangible (Pdu p r))
- newtype Endpoint protocol = Endpoint {}
- fromEndpoint :: forall protocol protocol. Iso (Endpoint protocol) (Endpoint protocol) ProcessId ProcessId
- proxyAsEndpoint :: proxy protocol -> ProcessId -> Endpoint protocol
- asEndpoint :: forall protocol. ProcessId -> Endpoint protocol
- class EmbedProtocol protocol embeddedProtocol where
- toEmbeddedEndpoint :: forall inner outer. EmbedProtocol outer inner => Endpoint outer -> Endpoint inner
- fromEmbeddedEndpoint :: forall outer inner. EmbedProtocol outer inner => Endpoint inner -> Endpoint outer
- prettyTypeableShows :: SomeTypeRep -> ShowS
- prettyTypeableShowsPrec :: Int -> SomeTypeRep -> ShowS
Documentation
class (NFData (Pdu protocol reply), Show (Pdu protocol reply), Typeable protocol, Typeable reply) => IsPdu (protocol :: Type) (reply :: Synchronicity) where Source #
This data family defines the protocol data units (PDU) of a protocol.
A Protocol in the sense of a communication interface description between processes.
The first parameter is usually a user defined type that identifies the
protocol that uses the Pdu
s are. It maybe a phantom type.
The second parameter specifies if a specific constructor of an (GADT-like)
Pdu
instance is Synchronous
, i.e. returns a result and blocks the caller
or if it is Asynchronous
Example:
data BookShop deriving Typeable instance IsPdu BookShop r where data instance Pdu BookShop r where RentBook :: BookId -> Pdu BookShop ('Synchronous (Either RentalError RentalId)) BringBack :: RentalId -> Pdu BookShop 'Asynchronous deriving Typeable type BookId = Int type RentalId = Int type RentalError = String
Since: 0.25.1
Nothing
deserializePdu :: Dynamic -> Maybe (Pdu protocol reply) Source #
deserializePdu :: Typeable (Pdu protocol reply) => Dynamic -> Maybe (Pdu protocol reply) Source #
Instances
(NFData (Pdu (Sup p) r), Show (Pdu (Sup p) r), Typeable p, Typeable r) => IsPdu (Sup p) r Source # | |
(Typeable o, Typeable r) => IsPdu (ObserverRegistry o) r Source # | |
Defined in Control.Eff.Concurrent.Protocol.Observer data Pdu (ObserverRegistry o) r :: Type Source # deserializePdu :: Dynamic -> Maybe (Pdu (ObserverRegistry o) r) Source # | |
(NFData o, Show o, Typeable o, Typeable r) => IsPdu (Observer o) r Source # | A minimal Protocol for handling observations.
This is one simple way of receiving observations - of course users can use
any other Since: 0.16.0 |
(IsPdu a1 r, IsPdu a2 r) => IsPdu (a1, a2) r Source # | |
(IsPdu a1 r, IsPdu a2 r, IsPdu a3 r) => IsPdu (a1, a2, a3) r Source # | |
(IsPdu a1 r, IsPdu a2 r, IsPdu a3 r, IsPdu a4 r) => IsPdu (a1, a2, a3, a4) r Source # | |
(IsPdu a1 r, IsPdu a2 r, IsPdu a3 r, IsPdu a4 r, IsPdu a5 r) => IsPdu (a1, a2, a3, a4, a5) r Source # | |
data Synchronicity Source #
The (promoted) constructors of this type specify (at the type level) the
reply behavior of a specific constructor of an Pdu
instance.
Synchronous Type | Specify that handling a request is a blocking operation
with a specific return type, e.g. |
Asynchronous | Non-blocking, asynchronous, request handling |
type family ProtocolReply (s :: Synchronicity) where ... Source #
This type function takes an Pdu
and analysis the reply type, i.e. the Synchronicity
and evaluates to either t
for an
Pdu x (
or to '()' for an Synchronous
t)Pdu x
.Asynchronous
Since: 0.24.0
ProtocolReply (Synchronous t) = t | |
ProtocolReply Asynchronous = () |
type TangiblePdu p r = (Typeable p, Typeable r, Tangible (Pdu p r)) Source #
A Constraint
that bundles the requirements for the
Pdu
values of a protocol.
This ensures that Pdu
s can be strictly and deeply evaluated and shown
such that for example logging is possible.
Since: 0.24.0
newtype Endpoint protocol Source #
Instances
Eq (Endpoint protocol) Source # | |
Ord (Endpoint protocol) Source # | |
Defined in Control.Eff.Concurrent.Protocol compare :: Endpoint protocol -> Endpoint protocol -> Ordering # (<) :: Endpoint protocol -> Endpoint protocol -> Bool # (<=) :: Endpoint protocol -> Endpoint protocol -> Bool # (>) :: Endpoint protocol -> Endpoint protocol -> Bool # (>=) :: Endpoint protocol -> Endpoint protocol -> Bool # max :: Endpoint protocol -> Endpoint protocol -> Endpoint protocol # min :: Endpoint protocol -> Endpoint protocol -> Endpoint protocol # | |
Typeable protocol => Show (Endpoint protocol) Source # | |
NFData (Endpoint protocol) Source # | |
Defined in Control.Eff.Concurrent.Protocol | |
type ToPretty (Endpoint a :: Type) Source # | |
fromEndpoint :: forall protocol protocol. Iso (Endpoint protocol) (Endpoint protocol) ProcessId ProcessId Source #
proxyAsEndpoint :: proxy protocol -> ProcessId -> Endpoint protocol Source #
asEndpoint :: forall protocol. ProcessId -> Endpoint protocol Source #
class EmbedProtocol protocol embeddedProtocol where Source #
A class for Pdu
instances that embed other Pdu
.
A Prism
for the embedded Pdu
is the center of this class
Laws: embeddedPdu = prism' embedPdu fromPdu
Since: 0.24.0
Nothing
embeddedPdu :: Prism' (Pdu protocol result) (Pdu embeddedProtocol result) Source #
embedPdu :: Pdu embeddedProtocol r -> Pdu protocol r Source #
fromPdu :: Pdu protocol r -> Maybe (Pdu embeddedProtocol r) Source #
Instances
EmbedProtocol a a Source # | |
EmbedProtocol (a1, a2) a2 Source # | |
EmbedProtocol (a1, a2) a1 Source # | |
EmbedProtocol (a1, a2, a3) a3 Source # | |
EmbedProtocol (a1, a2, a3) a2 Source # | |
EmbedProtocol (a1, a2, a3) a1 Source # | |
EmbedProtocol (a1, a2, a3, a4) a4 Source # | |
EmbedProtocol (a1, a2, a3, a4) a3 Source # | |
EmbedProtocol (a1, a2, a3, a4) a2 Source # | |
EmbedProtocol (a1, a2, a3, a4) a1 Source # | |
EmbedProtocol (a1, a2, a3, a4, a5) a5 Source # | |
EmbedProtocol (a1, a2, a3, a4, a5) a4 Source # | |
EmbedProtocol (a1, a2, a3, a4, a5) a3 Source # | |
EmbedProtocol (a1, a2, a3, a4, a5) a2 Source # | |
EmbedProtocol (a1, a2, a3, a4, a5) a1 Source # | |
toEmbeddedEndpoint :: forall inner outer. EmbedProtocol outer inner => Endpoint outer -> Endpoint inner Source #
Convert an Endpoint
to an endpoint for an embedded protocol.
See EmbedProtocol
, fromEmbeddedEndpoint
.
Since: 0.25.1
fromEmbeddedEndpoint :: forall outer inner. EmbedProtocol outer inner => Endpoint inner -> Endpoint outer Source #
Convert an Endpoint
to an endpoint for a server, that embeds the protocol.
See EmbedProtocol
, toEmbeddedEndpoint
.
Since: 0.25.1
prettyTypeableShows :: SomeTypeRep -> ShowS Source #
This is equivalent to prettyTypeableShowsPrec
0
Since: 0.24.0
prettyTypeableShowsPrec :: Int -> SomeTypeRep -> ShowS Source #