pinch-0.4.1.2: An alternative implementation of Thrift for Haskell.
Safe HaskellNone
LanguageHaskell2010

Pinch.Client

Synopsis

Basic Thrift client

data Client Source #

A simple Thrift Client.

Instances

Instances details
ThriftClient Client Source # 
Instance details

Defined in Pinch.Client

Methods

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

client :: Channel -> Client Source #

Instantiates a new Thrift client.

data Channel Source #

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

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

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

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

Creates a channel.

data ThriftCall a where Source #

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 Source #

Methods

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

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

Instances details
ThriftClient MultiplexClient Source # 
Instance details

Defined in Pinch.Client

Methods

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

ThriftClient Client Source # 
Instance details

Defined in Pinch.Client

Methods

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

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

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 Source #

A multiplexing thrift client.

Instances

Instances details
ThriftClient MultiplexClient Source # 
Instance details

Defined in Pinch.Client

Methods

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

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

Create a new multiplexing thrift client targeting the given service.

Errors

data ApplicationException Source #

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

Constructors

ApplicationException 

Fields

Instances

Instances details
Eq ApplicationException Source # 
Instance details

Defined in Pinch.Internal.Exception

Methods

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

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

Show ApplicationException Source # 
Instance details

Defined in Pinch.Internal.Exception

Methods

showsPrec :: Int -> ApplicationException -> ShowS #

show :: ApplicationException -> String #

showList :: [ApplicationException] -> ShowS #

Exception ApplicationException Source # 
Instance details

Defined in Pinch.Internal.Exception

Methods

toException :: ApplicationException -> SomeException #

fromException :: SomeException -> Maybe ApplicationException #

displayException :: ApplicationException -> String #

Pinchable ApplicationException Source # 
Instance details

Defined in Pinch.Internal.Exception

Associated Types

type Tag ApplicationException Source #

Methods

pinch :: ApplicationException -> Value (Tag ApplicationException) Source #

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

type Tag ApplicationException Source # 
Instance details

Defined in Pinch.Internal.Exception

type Tag ApplicationException = TStruct

data ExceptionType Source #

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

Instances details
Bounded ExceptionType Source # 
Instance details

Defined in Pinch.Internal.Exception

Methods

minBound :: ExceptionType #

maxBound :: ExceptionType #

Enum ExceptionType Source # 
Instance details

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 Source # 
Instance details

Defined in Pinch.Internal.Exception

Methods

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

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

Show ExceptionType Source # 
Instance details

Defined in Pinch.Internal.Exception

Methods

showsPrec :: Int -> ExceptionType -> ShowS #

show :: ExceptionType -> String #

showList :: [ExceptionType] -> ShowS #

Pinchable ExceptionType Source # 
Instance details

Defined in Pinch.Internal.Exception

Associated Types

type Tag ExceptionType Source #

Methods

pinch :: ExceptionType -> Value (Tag ExceptionType) Source #

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

type Tag ExceptionType Source # 
Instance details

Defined in Pinch.Internal.Exception

type Tag ExceptionType = TEnum

data ThriftError Source #

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

Constructors

ThriftError Text 

Instances

Instances details
Eq ThriftError Source # 
Instance details

Defined in Pinch.Internal.Exception

Methods

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

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

Show ThriftError Source # 
Instance details

Defined in Pinch.Internal.Exception

Methods

showsPrec :: Int -> ThriftError -> ShowS #

show :: ThriftError -> String #

showList :: [ThriftError] -> ShowS #

Exception ThriftError Source # 
Instance details

Defined in Pinch.Internal.Exception

Methods

toException :: ThriftError -> SomeException #

fromException :: SomeException -> Maybe ThriftError #

displayException :: ThriftError -> String #