http2-grpc-types-0.3.0.0: Types for gRPC over HTTP2 common for client and servers.

Safe HaskellNone
LanguageHaskell2010

Network.GRPC.HTTP2.Types

Description

Module for GRPC <> HTTP2 mapping.

Synopsis

Documentation

type HeaderKey = CI ByteString Source #

HTTP2 Header Key.

type HeaderValue = ByteString Source #

HTTP2 Header Value.

grpcTimeoutH :: HeaderKey Source #

grpcEncodingH :: HeaderKey Source #

grpcAcceptEncodingH :: HeaderKey Source #

grpcAcceptEncodingHVdefault :: HeaderValue Source #

grpcStatusH :: HeaderKey Source #

grpcMessageH :: HeaderKey Source #

grpcContentTypeHV :: HeaderValue Source #

data GRPCStatusCode Source #

Constructors

OK 
CANCELLED 
UNKNOWN 
INVALID_ARGUMENT 
DEADLINE_EXCEEDED 
NOT_FOUND 
ALREADY_EXISTS 
PERMISSION_DENIED 
UNAUTHENTICATED 
RESOURCE_EXHAUSTED 
FAILED_PRECONDITION 
ABORTED 
OUT_OF_RANGE 
UNIMPLEMENTED 
INTERNAL 
UNAVAILABLE 
DATA_LOSS 
Instances
Eq GRPCStatusCode Source # 
Instance details

Defined in Network.GRPC.HTTP2.Types

Methods

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

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

Ord GRPCStatusCode Source # 
Instance details

Defined in Network.GRPC.HTTP2.Types

Methods

compare :: GRPCStatusCode -> GRPCStatusCode -> Ordering #

(<) :: GRPCStatusCode -> GRPCStatusCode -> Bool #

(<=) :: GRPCStatusCode -> GRPCStatusCode -> Bool #

(>) :: GRPCStatusCode -> GRPCStatusCode -> Bool #

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

max :: GRPCStatusCode -> GRPCStatusCode -> GRPCStatusCode #

min :: GRPCStatusCode -> GRPCStatusCode -> GRPCStatusCode #

Show GRPCStatusCode Source # 
Instance details

Defined in Network.GRPC.HTTP2.Types

Methods

showsPrec :: Int -> GRPCStatusCode -> ShowS #

show :: GRPCStatusCode -> String #

showList :: [GRPCStatusCode] -> ShowS #

trailerForStatusCode :: GRPCStatusCode -> HeaderValue Source #

type GRPCStatusMessage = HeaderValue Source #

data GRPCStatus Source #

Constructors

GRPCStatus !GRPCStatusCode !GRPCStatusMessage 
Instances
Eq GRPCStatus Source # 
Instance details

Defined in Network.GRPC.HTTP2.Types

Methods

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

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

Ord GRPCStatus Source # 
Instance details

Defined in Network.GRPC.HTTP2.Types

Methods

compare :: GRPCStatus -> GRPCStatus -> Ordering #

(<) :: GRPCStatus -> GRPCStatus -> Bool #

(<=) :: GRPCStatus -> GRPCStatus -> Bool #

(>) :: GRPCStatus -> GRPCStatus -> Bool #

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

max :: GRPCStatus -> GRPCStatus -> GRPCStatus #

min :: GRPCStatus -> GRPCStatus -> GRPCStatus #

Show GRPCStatus Source # 
Instance details

Defined in Network.GRPC.HTTP2.Types

Methods

showsPrec :: Int -> GRPCStatus -> ShowS #

show :: GRPCStatus -> String #

showList :: [GRPCStatus] -> ShowS #

Exception GRPCStatus Source # 
Instance details

Defined in Network.GRPC.HTTP2.Types

Methods

toException :: GRPCStatus -> SomeException #

fromException :: SomeException -> Maybe GRPCStatus #

displayException :: GRPCStatus -> String #

statusCodeForTrailer :: HeaderValue -> Maybe GRPCStatusCode Source #

trailers :: GRPCStatus -> [(HeaderKey, HeaderValue)] Source #

Trailers for a GRPCStatus.

data InvalidGRPCStatus Source #

In case a server replies with a gRPC status/message pair un-understood by this library.

Constructors

InvalidGRPCStatus [(HeaderKey, HeaderValue)] 
Instances
Eq InvalidGRPCStatus Source # 
Instance details

Defined in Network.GRPC.HTTP2.Types

Methods

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

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

Ord InvalidGRPCStatus Source # 
Instance details

Defined in Network.GRPC.HTTP2.Types

Methods

compare :: InvalidGRPCStatus -> InvalidGRPCStatus -> Ordering #

(<) :: InvalidGRPCStatus -> InvalidGRPCStatus -> Bool #

(<=) :: InvalidGRPCStatus -> InvalidGRPCStatus -> Bool #

(>) :: InvalidGRPCStatus -> InvalidGRPCStatus -> Bool #

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

max :: InvalidGRPCStatus -> InvalidGRPCStatus -> InvalidGRPCStatus #

min :: InvalidGRPCStatus -> InvalidGRPCStatus -> InvalidGRPCStatus #

Show InvalidGRPCStatus Source # 
Instance details

Defined in Network.GRPC.HTTP2.Types

Methods

showsPrec :: Int -> InvalidGRPCStatus -> ShowS #

show :: InvalidGRPCStatus -> String #

showList :: [InvalidGRPCStatus] -> ShowS #

Exception InvalidGRPCStatus Source # 
Instance details

Defined in Network.GRPC.HTTP2.Types

Methods

toException :: InvalidGRPCStatus -> SomeException #

fromException :: SomeException -> Maybe InvalidGRPCStatus #

displayException :: InvalidGRPCStatus -> String #

readTrailers :: [(HeaderKey, HeaderValue)] -> Either InvalidGRPCStatus GRPCStatus Source #

Read a GRPCStatus from HTTP2 trailers.

data RPC (s :: *) (m :: Symbol) Source #

A proxy type for giving static information about RPCs.

Constructors

RPC 

path :: (Service s, HasMethod s m) => RPC s m -> HeaderValue Source #

Returns the HTTP2 :path for a given RPC.

newtype Timeout Source #

Timeout in seconds.

Constructors

Timeout Int 

showTimeout :: Timeout -> HeaderValue Source #

type Authority = HeaderValue Source #

The HTTP2-Authority portion of an URL (e.g., "dicioccio.fr:7777").