Pinch.Client

Basic Thrift client

data Client

A simple Thrift Client.

Instances

ThriftClient Client

Defined in Pinch.Client

Methods

call :: Client -> ThriftCall a -> IO a

client :: Channel -> Client

Instantiates a new Thrift client.

data Channel

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

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.

data ThriftCall a where

A call to a Thrift server resulting in the return datatype a.

Constructors

TCall :: (Pinchable req, Tag req ~ TStruct, Pinchable res, Tag res ~ TStruct) => !Text -> !req -> ThriftCall res

TOneway :: (Pinchable req, Tag req ~ TStruct) => !Text -> !req -> ThriftCall ()

class ThriftClient c where

Methods

call :: c -> ThriftCall a -> IO a

Calls a Thrift service and returns the result/error data structure. Application-level exceptions defined in the thrift service are returned as part of the result/error data structure.

Instances

ThriftClient MultiplexClient

Defined in Pinch.Client

Methods

call :: MultiplexClient -> ThriftCall a -> IO a

ThriftClient Client

Defined in Pinch.Client

Methods

call :: Client -> ThriftCall a -> IO a

callOrThrow :: (ThriftClient c, ThriftResult a) => c -> ThriftCall a -> IO (ResultType a)

Calls a Thrift service. If an application-level thrift exception as defined in the Thrift service definition is returned by the server, it will be re-thrown using throwIO.

Multiplexing Client

data MultiplexClient

A multiplexing thrift client.

Instances

ThriftClient MultiplexClient

Defined in Pinch.Client

Methods

call :: MultiplexClient -> ThriftCall a -> IO a

multiplexClient :: ThriftClient c => c -> ServiceName -> MultiplexClient

Create a new multiplexing thrift client targeting the given service.

Errors

data ApplicationException

Thrift application exception as defined in https://github.com/apache/thrift/blob/master/doc/specs/thrift-rpc.md#response-struct.

Constructors

ApplicationException

Fields

• appExMessage :: Text
• appExType :: ExceptionType

Instances

Eq ApplicationException

Defined in Pinch.Internal.Exception

Methods

(==) :: ApplicationException -> ApplicationException -> Bool

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

Show ApplicationException

Defined in Pinch.Internal.Exception

Methods

showsPrec :: Int -> ApplicationException -> ShowS

show :: ApplicationException -> String

showList :: [ApplicationException] -> ShowS

Exception ApplicationException

Defined in Pinch.Internal.Exception

Methods

toException :: ApplicationException -> SomeException

fromException :: SomeException -> Maybe ApplicationException

displayException :: ApplicationException -> String

Pinchable ApplicationException

Defined in Pinch.Internal.Exception

Associated Types

type Tag ApplicationException

Methods

pinch :: ApplicationException -> Value (Tag ApplicationException)

unpinch :: Value (Tag ApplicationException) -> Parser ApplicationException

type Tag ApplicationException

Defined in Pinch.Internal.Exception

type Tag ApplicationException = TStruct

data ExceptionType

Thrift exception type as defined in https://github.com/apache/thrift/blob/master/doc/specs/thrift-rpc.md#response-struct.

Constructors

Unknown

UnknownMethod

InvalidMessageType

WrongMethodName

BadSequenceId

MissingResult

InternalError

ProtocolError

InvalidTransform

InvalidProtocol

UnsupportedClientType

Instances

Bounded ExceptionType

Defined in Pinch.Internal.Exception

Methods

minBound :: ExceptionType

maxBound :: ExceptionType

Enum ExceptionType

Defined in Pinch.Internal.Exception

Methods

succ :: ExceptionType -> ExceptionType

pred :: ExceptionType -> ExceptionType

toEnum :: Int -> ExceptionType

fromEnum :: ExceptionType -> Int

enumFrom :: ExceptionType -> [ExceptionType]

enumFromThen :: ExceptionType -> ExceptionType -> [ExceptionType]

enumFromTo :: ExceptionType -> ExceptionType -> [ExceptionType]

enumFromThenTo :: ExceptionType -> ExceptionType -> ExceptionType -> [ExceptionType]

Eq ExceptionType

Defined in Pinch.Internal.Exception

Methods

(==) :: ExceptionType -> ExceptionType -> Bool

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

Show ExceptionType

Defined in Pinch.Internal.Exception

Methods

showsPrec :: Int -> ExceptionType -> ShowS

show :: ExceptionType -> String

showList :: [ExceptionType] -> ShowS

Pinchable ExceptionType

Defined in Pinch.Internal.Exception

Associated Types

type Tag ExceptionType

Methods

pinch :: ExceptionType -> Value (Tag ExceptionType)

unpinch :: Value (Tag ExceptionType) -> Parser ExceptionType

type Tag ExceptionType

Defined in Pinch.Internal.Exception

type Tag ExceptionType = TEnum

data ThriftError

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

Constructors

ThriftError Text

Instances

Eq ThriftError

Defined in Pinch.Internal.Exception

Methods

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

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

Show ThriftError

Defined in Pinch.Internal.Exception

Methods

showsPrec :: Int -> ThriftError -> ShowS

show :: ThriftError -> String

showList :: [ThriftError] -> ShowS

Exception ThriftError

Defined in Pinch.Internal.Exception

Methods

toException :: ThriftError -> SomeException

fromException :: SomeException -> Maybe ThriftError

displayException :: ThriftError -> String