Safe Haskell	None
Language	Haskell2010

Network.GRPC.Server.Handlers

Synopsis

type UnaryHandler m i o = Request -> i -> m o
unary :: (GRPCInput r i, GRPCOutput r o) => r -> UnaryHandler IO i o -> ServiceHandler
type ServerStreamHandler m i o a = Request -> i -> m (a, ServerStream m o a)
newtype ServerStream m o a = ServerStream {
- serverStreamNext :: a -> m (Maybe (a, o))
}
serverStream :: (GRPCInput r i, GRPCOutput r o) => r -> ServerStreamHandler IO i o a -> ServiceHandler
type ClientStreamHandler m i o a = Request -> m (a, ClientStream m i o a)
data ClientStream m i o a = ClientStream {
- clientStreamHandler :: a -> i -> m a
- clientStreamFinalizer :: a -> m o
}
clientStream :: (GRPCInput r i, GRPCOutput r o) => r -> ClientStreamHandler IO i o a -> ServiceHandler
type BiDiStreamHandler m i o a = Request -> m (a, BiDiStream m i o a)
data BiDiStep m i o a
- = Abort
- | WaitInput !(a -> i -> m a) !(a -> m a)
- | WriteOutput !a o
newtype BiDiStream m i o a = BiDiStream {
- bidirNextStep :: a -> m (BiDiStep m i o a)
}
bidiStream :: (GRPCInput r i, GRPCOutput r o) => r -> BiDiStreamHandler IO i o a -> ServiceHandler
type GeneralStreamHandler m i o a b = Request -> m (a, IncomingStream m i a, b, OutgoingStream m o b)
data IncomingStream m i a = IncomingStream {
- incomingStreamHandler :: a -> i -> m a
- incomingStreamFinalizer :: a -> m ()
}
newtype OutgoingStream m o a = OutgoingStream {
- outgoingStreamNext :: a -> m (Maybe (a, o))
}
generalStream :: (GRPCInput r i, GRPCOutput r o) => r -> GeneralStreamHandler IO i o a b -> ServiceHandler

Documentation

type UnaryHandler m i o = Request -> i -> m o Source #

Handy type to refer to Handler for unary RPCs handler.

unary :: (GRPCInput r i, GRPCOutput r o) => r -> UnaryHandler IO i o -> ServiceHandler Source #

type ServerStreamHandler m i o a = Request -> i -> m (a, ServerStream m o a) Source #

Handy type for 'server-streaming' RPCs.

We expect an implementation to: - read the input request - return an initial state and an state-passing action that the server code will call to fetch the output to send to the client (or close an a Nothing) See ServerStream for the type which embodies these requirements.

newtype ServerStream m o a Source #

Constructors

ServerStream
Fields serverStreamNext :: a -> m (Maybe (a, o))

serverStream :: (GRPCInput r i, GRPCOutput r o) => r -> ServerStreamHandler IO i o a -> ServiceHandler Source #

type ClientStreamHandler m i o a = Request -> m (a, ClientStream m i o a) Source #

Handy type for 'client-streaming' RPCs.

We expect an implementation to: - acknowledge a the new client stream by returning an initial state and two functions: - a state-passing handler for new client message - a state-aware handler for answering the client when it is ending its stream See ClientStream for the type which embodies these requirements.

data ClientStream m i o a Source #

Constructors

ClientStream
Fields clientStreamHandler :: a -> i -> m a clientStreamFinalizer :: a -> m o

clientStream :: (GRPCInput r i, GRPCOutput r o) => r -> ClientStreamHandler IO i o a -> ServiceHandler Source #

type BiDiStreamHandler m i o a = Request -> m (a, BiDiStream m i o a) Source #

Handy type for 'bidirectional-streaming' RPCs.

We expect an implementation to: - acknowlege a new bidirection stream by returning an initial state and one functions: - a state-passing function that returns a single action step The action may be to - stop immediately - wait and handle some input with a callback and a finalizer (if the client closes the stream on its side) that may change the state - return a value and a new state

There is no way to stop locally (that would mean sending HTTP2 trailers) and keep receiving messages from the client.

data BiDiStep m i o a Source #

Constructors

Abort
WaitInput !(a -> i -> m a) !(a -> m a)
WriteOutput !a o

newtype BiDiStream m i o a Source #

Constructors

BiDiStream
Fields bidirNextStep :: a -> m (BiDiStep m i o a)

bidiStream :: (GRPCInput r i, GRPCOutput r o) => r -> BiDiStreamHandler IO i o a -> ServiceHandler Source #

type GeneralStreamHandler m i o a b = Request -> m (a, IncomingStream m i a, b, OutgoingStream m o b) Source #

A GeneralStreamHandler combining server and client asynchronous streams.

data IncomingStream m i a Source #

Pair of handlers for reacting to incoming messages.

Constructors

IncomingStream
Fields incomingStreamHandler :: a -> i -> m a incomingStreamFinalizer :: a -> m ()

newtype OutgoingStream m o a Source #

Handler to decide on the next message (if any) to return.

Constructors

OutgoingStream
Fields outgoingStreamNext :: a -> m (Maybe (a, o))

generalStream :: (GRPCInput r i, GRPCOutput r o) => r -> GeneralStreamHandler IO i o a b -> ServiceHandler Source #