Pinch.Server

Thrift Server creation

newtype ThriftServer

A Thrift server. Takes the context and the request as input and may produces a reply message.

Constructors

ThriftServer

Fields

• unThriftServer :: forall a. Context -> Request a -> IO a

createServer :: (Text -> Maybe Handler) -> ThriftServer

Creates a new thrift server processing requests with the function f.

By default, if processing a oneway call fails a haskell exception is thrown which will likely terminate the guilty connection. You may use the onError combinator to handle this case more gracefully.

data Handler where

Create a handler for a request type.

Constructors

CallHandler :: (Pinchable c, Tag c ~ TStruct, Pinchable r, Tag r ~ TStruct) => (Context -> c -> IO r) -> Handler

Handle normal call requests. Must return a result.

OnewayHandler :: (Pinchable c, Tag c ~ TStruct) => (Context -> c -> IO ()) -> Handler

Handle oneway requests. Cannot return any result.

data Request out where

A single request to a thrift server.

Constructors

RCall :: !Message -> Request Message

ROneway :: !Message -> Request ()

Instances

Show (Request out)

Defined in Pinch.Server

Methods

showsPrec :: Int -> Request out -> ShowS

show :: Request out -> String

showList :: [Request out] -> ShowS

Running a Thrift Server

runConnection :: Context -> ThriftServer -> Channel -> IO ()

Run a Thrift server for a single connection.

data ThriftError

An error occured while processing a thrift call. Signals errors like premature EOF, Thrift protocol parsing failures etc.

Constructors

ThriftError Text

Instances

Exception ThriftError

Defined in Pinch.Internal.Exception

Methods

toException :: ThriftError -> SomeException

fromException :: SomeException -> Maybe ThriftError

displayException :: ThriftError -> String

Show ThriftError

Defined in Pinch.Internal.Exception

Methods

showsPrec :: Int -> ThriftError -> ShowS

show :: ThriftError -> String

showList :: [ThriftError] -> ShowS

Eq ThriftError

Defined in Pinch.Internal.Exception

Methods

(==) :: ThriftError -> ThriftError -> Bool

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

data Channel

A bi-directional channel to read/write Thrift messages.

Constructors

Channel

Fields

• cTransportIn :: !Transport
• cTransportOut :: !Transport
• cProtocolIn :: !Protocol
• cProtocolOut :: !Protocol

createChannel :: Connection c => c -> (c -> IO Transport) -> Protocol -> IO Channel

Creates a channel using the same transport/protocol for both directions.

createChannel1 :: (Transport, Protocol) -> (Transport, Protocol) -> Channel

Creates a channel.

Thrift Server context

The context can be used to pass data from the environment to the thrift server functions. For example, you could pass the remote host name to the server to use it for logging purposes.

data Context

Allows passing context information to a ThriftServer. The context is indexed by type.

Instances

Monoid Context

Defined in Pinch.Server

Methods

mempty :: Context

mappend :: Context -> Context -> Context

mconcat :: [Context] -> Context

Semigroup Context

Defined in Pinch.Server

Methods

(<>) :: Context -> Context -> Context

sconcat :: NonEmpty Context -> Context

stimes :: Integral b => b -> Context -> Context

class Typeable a => ContextItem a

Instances

ContextItem ServiceName

Defined in Pinch.Server

addToContext :: forall i. ContextItem i => i -> Context -> Context

Adds a new item to the context. If an item with the same type is already part of the context, it will be overwritten.

lookupInContext :: forall i. ContextItem i => Context -> Maybe i

Lookup a value in the context.

Middlewares

multiplex :: [(ServiceName, ThriftServer)] -> ThriftServer

Multiplex multiple services into a single ThriftServer.

The service name is added to the Context and may be retrieved using `lookupInContext @ServiceName ctx`.

newtype ServiceName

Constructors

ServiceName Text

Instances

IsString ServiceName

Defined in Pinch.Internal.RPC

Methods

fromString :: String -> ServiceName

Eq ServiceName

Defined in Pinch.Internal.RPC

Methods

(==) :: ServiceName -> ServiceName -> Bool

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

Hashable ServiceName

Defined in Pinch.Internal.RPC

Methods

hashWithSalt :: Int -> ServiceName -> Int

hash :: ServiceName -> Int

ContextItem ServiceName

Defined in Pinch.Server

onError

Arguments

:: Exception e

=> (e -> Maybe a)

Select exceptions to handle.

-> (a -> IO Message)

Error handler for normal method calls.

-> (a -> IO ())

Error handler for oneway calls.

-> ThriftServer

-> ThriftServer

Add error handlers to a ThriftServer. Exceptions are caught and not re-thrown, but you may do so by calling ioThrow yourself.

Helper functions

Functions mostly useful for defining custom ThriftServers.

mapRequestMessage :: (Message -> Message) -> Request o -> Request o

Map the message contained in the request.

getRequestMessage :: Request o -> Message

Extract the message contained in the request.

mkApplicationExceptionReply :: Message -> ApplicationException -> Message

Builds an exception reply given the corresponding request message.