Network.RPC.Curryer.Server

Documentation

traceBytes :: Applicative f => String -> ByteString -> f ()

msgSerialise :: Serialise a => a -> ByteString

msgDeserialise :: forall s. Serialise s => ByteString -> Either WineryException s

data Locking a

Constructors

Locking (MVar ()) a

newLock :: a -> IO (Locking a)

withLock :: Locking a -> (a -> IO b) -> IO b

lockless :: Locking a -> a

type Timeout = Word32

type BinaryMessage = ByteString

data Envelope

Constructors

Envelope

Fields

• envFingerprint :: !Fingerprint
• envMessageType :: !MessageType
• envMsgId :: !UUID
• envPayload :: !BinaryMessage

Instances

Show Envelope

Defined in Network.RPC.Curryer.Server

Methods

showsPrec :: Int -> Envelope -> ShowS

show :: Envelope -> String

showList :: [Envelope] -> ShowS

Generic Envelope

Defined in Network.RPC.Curryer.Server

Associated Types

type Rep Envelope :: Type -> Type

Methods

from :: Envelope -> Rep Envelope x

to :: Rep Envelope x -> Envelope

type Rep Envelope

Defined in Network.RPC.Curryer.Server

type Rep Envelope = D1 ('MetaData "Envelope" "Network.RPC.Curryer.Server" "curryer-rpc-0.2.1-437sH79qxud4JWxPSdQGcG" 'False) (C1 ('MetaCons "Envelope" 'PrefixI 'True) ((S1 ('MetaSel ('Just "envFingerprint") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Fingerprint) :*: S1 ('MetaSel ('Just "envMessageType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MessageType)) :*: (S1 ('MetaSel ('Just "envMsgId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UUID) :*: S1 ('MetaSel ('Just "envPayload") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BinaryMessage))))

type TimeoutMicroseconds = Int

data MessageType

Internal type used to mark envelope types.

Constructors

RequestMessage TimeoutMicroseconds

ResponseMessage

TimeoutResponseMessage

ExceptionResponseMessage

Instances

Show MessageType

Defined in Network.RPC.Curryer.Server

Methods

showsPrec :: Int -> MessageType -> ShowS

show :: MessageType -> String

showList :: [MessageType] -> ShowS

Generic MessageType

Defined in Network.RPC.Curryer.Server

Associated Types

type Rep MessageType :: Type -> Type

Methods

from :: MessageType -> Rep MessageType x

to :: Rep MessageType x -> MessageType

Serialise MessageType

Defined in Network.RPC.Curryer.Server

Methods

schemaGen :: Proxy MessageType -> SchemaGen Schema

toBuilder :: MessageType -> Builder

extractor :: Extractor MessageType

decodeCurrent :: Decoder MessageType

bundleSerialise :: BundleSerialise MessageType

type Rep MessageType

Defined in Network.RPC.Curryer.Server

type Rep MessageType = D1 ('MetaData "MessageType" "Network.RPC.Curryer.Server" "curryer-rpc-0.2.1-437sH79qxud4JWxPSdQGcG" 'False) ((C1 ('MetaCons "RequestMessage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TimeoutMicroseconds)) :+: C1 ('MetaCons "ResponseMessage" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "TimeoutResponseMessage" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ExceptionResponseMessage" 'PrefixI 'False) (U1 :: Type -> Type)))

type RequestHandlers serverState = [RequestHandler serverState]

A list of RequestHandlers.

data RequestHandler serverState where

Data types for server-side request handlers, in synchronous (client waits for return value) and asynchronous (client does not wait for return value) forms.

Constructors

RequestHandler :: forall a b serverState. (Serialise a, Serialise b) => (ConnectionState serverState -> a -> IO b) -> RequestHandler serverState

create a request handler with a response

AsyncRequestHandler :: forall a serverState. Serialise a => (ConnectionState serverState -> a -> IO ()) -> RequestHandler serverState

create an asynchronous request handler where the client does not expect nor await a response

data ConnectionState a

Server state sent in via serve and passed to RequestHandlers.

Constructors

ConnectionState

Fields

• connectionServerState :: a
• connectionSocket :: Locking Socket

sendMessage :: Serialise a => Locking Socket -> a -> IO ()

Used by server-side request handlers to send additional messages to the client. This is useful for sending asynchronous responses to the client outside of the normal request-response flow. The locking socket can be found in the ConnectionState when a request handler is called.

newtype UUID

Constructors

UUID

Fields

• _unUUID :: UUID

Instances

Eq UUID

Defined in Network.RPC.Curryer.Server

Methods

(==) :: UUID -> UUID -> Bool

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

Show UUID

Defined in Network.RPC.Curryer.Server

Methods

showsPrec :: Int -> UUID -> ShowS

show :: UUID -> String

showList :: [UUID] -> ShowS

Hashable UUID

Defined in Network.RPC.Curryer.Server

Methods

hashWithSalt :: Int -> UUID -> Int

hash :: UUID -> Int

Binary UUID

Defined in Network.RPC.Curryer.Server

Methods

put :: UUID -> Put

get :: Get UUID

putList :: [UUID] -> Put

Serialise UUID

Defined in Network.RPC.Curryer.Server

Methods

schemaGen :: Proxy UUID -> SchemaGen Schema

toBuilder :: UUID -> Builder

extractor :: Extractor UUID

decodeCurrent :: Decoder UUID

bundleSerialise :: BundleSerialise UUID

data ConnectionError

Errors from remote calls.

Constructors

CodecError String

TimeoutError

ExceptionError String

Instances

Eq ConnectionError

Defined in Network.RPC.Curryer.Server

Methods

(==) :: ConnectionError -> ConnectionError -> Bool

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

Show ConnectionError

Defined in Network.RPC.Curryer.Server

Methods

showsPrec :: Int -> ConnectionError -> ShowS

show :: ConnectionError -> String

showList :: [ConnectionError] -> ShowS

Generic ConnectionError

Defined in Network.RPC.Curryer.Server

Associated Types

type Rep ConnectionError :: Type -> Type

Methods

from :: ConnectionError -> Rep ConnectionError x

to :: Rep ConnectionError x -> ConnectionError

Serialise ConnectionError

Defined in Network.RPC.Curryer.Server

Methods

schemaGen :: Proxy ConnectionError -> SchemaGen Schema

toBuilder :: ConnectionError -> Builder

extractor :: Extractor ConnectionError

decodeCurrent :: Decoder ConnectionError

bundleSerialise :: BundleSerialise ConnectionError

type Rep ConnectionError

Defined in Network.RPC.Curryer.Server

type Rep ConnectionError = D1 ('MetaData "ConnectionError" "Network.RPC.Curryer.Server" "curryer-rpc-0.2.1-437sH79qxud4JWxPSdQGcG" 'False) (C1 ('MetaCons "CodecError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: (C1 ('MetaCons "TimeoutError" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ExceptionError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

data TimeoutException

Constructors

TimeoutException

Instances

Show TimeoutException

Defined in Network.RPC.Curryer.Server

Methods

showsPrec :: Int -> TimeoutException -> ShowS

show :: TimeoutException -> String

showList :: [TimeoutException] -> ShowS

Exception TimeoutException

Defined in Network.RPC.Curryer.Server

Methods

toException :: TimeoutException -> SomeException

fromException :: SomeException -> Maybe TimeoutException

displayException :: TimeoutException -> String

type HostAddr = (Word8, Word8, Word8, Word8)

allHostAddrs :: HostAddr

localHostAddr :: HostAddr

msgTypeP :: Parser IO Word8 MessageType

envelopeP :: Parser IO Word8 Envelope

encodeEnvelope :: Envelope -> ByteString

fingerprintP :: Parser IO Word8 Fingerprint

word64P :: Parser IO Word8 Word64

word32P :: Parser IO Word8 Word32

uuidP :: Parser IO Word8 UUID

type NewConnectionHandler msg = IO (Maybe msg)

type NewMessageHandler req resp = req -> IO resp

serve :: RequestHandlers s -> s -> HostAddr -> PortNumber -> Maybe (MVar SockAddr) -> IO Bool

Listen for new connections and handle requests which are passed the server state s. The MVar SockAddr can be be optionally used to know when the server is ready for processing requests.

openEnvelope :: forall s. (Serialise s, Typeable s) => Envelope -> Maybe s

deserialiseOnly :: forall s. Serialise s => ByteString -> Either WineryException s

matchEnvelope :: forall a b s. (Serialise a, Serialise b, Typeable b) => Envelope -> (ConnectionState s -> a -> IO b) -> Maybe (ConnectionState s -> a -> IO b, a)

serverEnvelopeHandler :: Locking Socket -> RequestHandlers s -> s -> Envelope -> IO ()

Called by serve to process incoming envelope requests. Never returns, so use async to spin it off on another thread.

type EnvelopeHandler = Envelope -> IO ()

drainSocketMessages :: Socket -> EnvelopeHandler -> IO ()

sendEnvelope :: Envelope -> Locking Socket -> IO ()

fingerprint :: Typeable a => a -> Fingerprint

fromArray :: Array Word8 -> ByteString

Orphan instances

Generic Fingerprint

Associated Types

type Rep Fingerprint :: Type -> Type

Methods

from :: Fingerprint -> Rep Fingerprint x

to :: Rep Fingerprint x -> Fingerprint

Serialise Fingerprint

Methods

schemaGen :: Proxy Fingerprint -> SchemaGen Schema

toBuilder :: Fingerprint -> Builder

extractor :: Extractor Fingerprint

decodeCurrent :: Decoder Fingerprint

bundleSerialise :: BundleSerialise Fingerprint