Safe Haskell	None
Language	Haskell2010

Network.GRPC.HighLevel

Contents

Types
Server
Client
Client and Server Auth
Server Auth
Client Auth
Streaming utilities

Synopsis

newtype MetadataMap = MetadataMap {
- unMap :: Map ByteString (SortedList ByteString)
}
newtype MethodName = MethodName {
- unMethodName :: ByteString
}
newtype StatusDetails = StatusDetails {
- unStatusDetails :: ByteString
}
data StatusCode
- = StatusDoNotUse
- | StatusOk
- | StatusCancelled
- | StatusUnknown
- | StatusInvalidArgument
- | StatusDeadlineExceeded
- | StatusNotFound
- | StatusAlreadyExists
- | StatusPermissionDenied
- | StatusResourceExhausted
- | StatusFailedPrecondition
- | StatusAborted
- | StatusOutOfRange
- | StatusUnimplemented
- | StatusInternal
- | StatusUnavailable
- | StatusDataLoss
- | StatusUnauthenticated
data GRPCIOError
- = GRPCIOCallError CallError
- | GRPCIOTimeout
- | GRPCIOShutdown
- | GRPCIOShutdownFailure
- | GRPCIOUnknownError
- | GRPCIOBadStatusCode StatusCode StatusDetails
- | GRPCIODecodeError String
- | GRPCIOInternalUnexpectedRecv String
- | GRPCIOHandlerException String
data GRPCImpl
- = ServerImpl
- | ClientImpl
type family MkHandler (impl :: GRPCImpl) (methodType :: GRPCMethodType) i o
data ServiceOptions = ServiceOptions {
- serverHost :: Host
- serverPort :: Port
- useCompression :: Bool
- userAgentPrefix :: String
- userAgentSuffix :: String
- initialMetadata :: MetadataMap
- sslConfig :: Maybe ServerSSLConfig
- logger :: String -> IO ()
- serverMaxReceiveMessageLength :: Maybe Natural
}
data Handler (a :: GRPCMethodType) where
- UnaryHandler :: (Message c, Message d) => MethodName -> ServerHandler c d -> Handler 'Normal
- ClientStreamHandler :: (Message c, Message d) => MethodName -> ServerReaderHandler c d -> Handler 'ClientStreaming
- ServerStreamHandler :: (Message c, Message d) => MethodName -> ServerWriterHandler c d -> Handler 'ServerStreaming
- BiDiStreamHandler :: (Message c, Message d) => MethodName -> ServerRWHandler c d -> Handler 'BiDiStreaming
data ServerOptions = ServerOptions {
- optNormalHandlers :: [Handler 'Normal]
- optClientStreamHandlers :: [Handler 'ClientStreaming]
- optServerStreamHandlers :: [Handler 'ServerStreaming]
- optBiDiStreamHandlers :: [Handler 'BiDiStreaming]
- optServerHost :: Host
- optServerPort :: Port
- optUseCompression :: Bool
- optUserAgentPrefix :: String
- optUserAgentSuffix :: String
- optInitialMetadata :: MetadataMap
- optSSLConfig :: Maybe ServerSSLConfig
- optLogger :: String -> IO ()
- optMaxReceiveMessageLength :: Maybe Natural
}
defaultOptions :: ServerOptions
serverLoop :: ServerOptions -> IO ()
data ServerCall a = ServerCall {
- unsafeSC :: Call
- callCQ :: CompletionQueue
- metadata :: MetadataMap
- payload :: a
- callDeadline :: TimeSpec
}
serverCallCancel :: ServerCall a -> StatusCode -> String -> IO ()
serverCallIsExpired :: ServerCall a -> IO Bool
data NormalRequestResult = NormalRequestResult {
- rspBody :: ByteString
- initMD :: MetadataMap
- trailMD :: MetadataMap
- rspCode :: StatusCode
- details :: StatusDetails
}
data ClientCall
clientCallCancel :: ClientCall -> IO ()
data AuthContext
data AuthProperty = AuthProperty {
- authPropName :: ByteString
- authPropValue :: ByteString
}
getAuthProperties :: AuthContext -> IO [AuthProperty]
addAuthProperty :: AuthContext -> AuthProperty -> IO ()
data ServerSSLConfig = ServerSSLConfig {
- clientRootCert :: Maybe FilePath
- serverPrivateKey :: FilePath
- serverCert :: FilePath
- clientCertRequest :: SslClientCertificateRequestType
- customMetadataProcessor :: Maybe ProcessMeta
}
type ProcessMeta = AuthContext -> MetadataMap -> IO AuthProcessorResult
data AuthProcessorResult = AuthProcessorResult {
- resultConsumedMetadata :: MetadataMap
- resultResponseMetadata :: MetadataMap
- resultStatus :: StatusCode
- resultStatusDetails :: StatusDetails
}
data SslClientCertificateRequestType
- = SslDontRequestClientCertificate
- | SslRequestClientCertificateButDontVerify
- | SslRequestClientCertificateAndVerify
- | SslRequestAndRequireClientCertificateButDontVerify
- | SslRequestAndRequireClientCertificateAndVerify
data ClientSSLConfig = ClientSSLConfig {
- serverRootCert :: Maybe FilePath
- clientSSLKeyCertPair :: Maybe ClientSSLKeyCertPair
- clientMetadataPlugin :: Maybe ClientMetadataCreate
}
data ClientSSLKeyCertPair = ClientSSLKeyCertPair {
- clientPrivateKey :: FilePath
- clientCert :: FilePath
}
type ClientMetadataCreate = AuthMetadataContext -> IO ClientMetadataCreateResult
data ClientMetadataCreateResult = ClientMetadataCreateResult {
- clientResultMetadata :: MetadataMap
- clientResultStatus :: StatusCode
- clientResultDetails :: StatusDetails
}
data AuthMetadataContext = AuthMetadataContext {
- serviceURL :: ByteString
- methodName :: ByteString
- channelAuthContext :: AuthContext
}
type StreamSend a = a -> IO (Either GRPCIOError ())
type StreamRecv a = IO (Either GRPCIOError (Maybe a))

Types

newtype MetadataMap #

Represents metadata for a given RPC, consisting of key-value pairs. Keys are allowed to be repeated. Since repeated keys are unlikely in practice, the IsList instance uses key-value pairs as items. For example, fromList [("key1","val1"),("key2","val2"),("key1","val3")].

Constructors

MetadataMap
Fields unMap :: Map ByteString (SortedList ByteString)

Instances

Instances details

IsList MetadataMap
Instance details Defined in Network.GRPC.Unsafe.Metadata Associated Types type Item MetadataMap # Methods fromList :: [Item MetadataMap] -> MetadataMap # fromListN :: Int -> [Item MetadataMap] -> MetadataMap # toList :: MetadataMap -> [Item MetadataMap] #
Eq MetadataMap
Instance details Defined in Network.GRPC.Unsafe.Metadata Methods (==) :: MetadataMap -> MetadataMap -> Bool # (/=) :: MetadataMap -> MetadataMap -> Bool #
Show MetadataMap
Instance details Defined in Network.GRPC.Unsafe.Metadata Methods showsPrec :: Int -> MetadataMap -> ShowS # show :: MetadataMap -> String # showList :: [MetadataMap] -> ShowS #
Semigroup MetadataMap
Instance details Defined in Network.GRPC.Unsafe.Metadata Methods (<>) :: MetadataMap -> MetadataMap -> MetadataMap # sconcat :: NonEmpty MetadataMap -> MetadataMap # stimes :: Integral b => b -> MetadataMap -> MetadataMap #
Monoid MetadataMap
Instance details Defined in Network.GRPC.Unsafe.Metadata Methods mempty :: MetadataMap # mappend :: MetadataMap -> MetadataMap -> MetadataMap # mconcat :: [MetadataMap] -> MetadataMap #
type Item MetadataMap
Instance details Defined in Network.GRPC.Unsafe.Metadata type Item MetadataMap = (ByteString, ByteString)

newtype MethodName #

Constructors

MethodName
Fields unMethodName :: ByteString

Instances

Instances details

Eq MethodName
Instance details Defined in Network.GRPC.LowLevel.Call Methods (==) :: MethodName -> MethodName -> Bool # (/=) :: MethodName -> MethodName -> Bool #
Show MethodName
Instance details Defined in Network.GRPC.LowLevel.Call Methods showsPrec :: Int -> MethodName -> ShowS # show :: MethodName -> String # showList :: [MethodName] -> ShowS #
IsString MethodName
Instance details Defined in Network.GRPC.LowLevel.Call Methods fromString :: String -> MethodName #

newtype StatusDetails #

Constructors

StatusDetails
Fields unStatusDetails :: ByteString

Instances

Instances details

Eq StatusDetails
Instance details Defined in Network.GRPC.Unsafe Methods (==) :: StatusDetails -> StatusDetails -> Bool # (/=) :: StatusDetails -> StatusDetails -> Bool #
Show StatusDetails
Instance details Defined in Network.GRPC.Unsafe Methods showsPrec :: Int -> StatusDetails -> ShowS # show :: StatusDetails -> String # showList :: [StatusDetails] -> ShowS #
IsString StatusDetails
Instance details Defined in Network.GRPC.Unsafe Methods fromString :: String -> StatusDetails #
Semigroup StatusDetails
Instance details Defined in Network.GRPC.Unsafe Methods (<>) :: StatusDetails -> StatusDetails -> StatusDetails # sconcat :: NonEmpty StatusDetails -> StatusDetails # stimes :: Integral b => b -> StatusDetails -> StatusDetails #
Monoid StatusDetails
Instance details Defined in Network.GRPC.Unsafe Methods mempty :: StatusDetails # mappend :: StatusDetails -> StatusDetails -> StatusDetails # mconcat :: [StatusDetails] -> StatusDetails #

data StatusCode #

Constructors

StatusDoNotUse
StatusOk
StatusCancelled
StatusUnknown
StatusInvalidArgument
StatusDeadlineExceeded
StatusNotFound
StatusAlreadyExists
StatusPermissionDenied
StatusResourceExhausted
StatusFailedPrecondition
StatusAborted
StatusOutOfRange
StatusUnimplemented
StatusInternal
StatusUnavailable
StatusDataLoss
StatusUnauthenticated

Instances

Instances details

Enum StatusCode
Instance details Defined in Network.GRPC.Unsafe.Op Methods succ :: StatusCode -> StatusCode # pred :: StatusCode -> StatusCode # toEnum :: Int -> StatusCode # fromEnum :: StatusCode -> Int # enumFrom :: StatusCode -> [StatusCode] # enumFromThen :: StatusCode -> StatusCode -> [StatusCode] # enumFromTo :: StatusCode -> StatusCode -> [StatusCode] # enumFromThenTo :: StatusCode -> StatusCode -> StatusCode -> [StatusCode] #
Eq StatusCode
Instance details Defined in Network.GRPC.Unsafe.Op Methods (==) :: StatusCode -> StatusCode -> Bool # (/=) :: StatusCode -> StatusCode -> Bool #
Read StatusCode
Instance details Defined in Network.GRPC.Unsafe.Op Methods readsPrec :: Int -> ReadS StatusCode # readList :: ReadS [StatusCode] # readPrec :: ReadPrec StatusCode # readListPrec :: ReadPrec [StatusCode] #
Show StatusCode
Instance details Defined in Network.GRPC.Unsafe.Op Methods showsPrec :: Int -> StatusCode -> ShowS # show :: StatusCode -> String # showList :: [StatusCode] -> ShowS #

data GRPCIOError #

Describes all errors that can occur while running a GRPC-related IO action.

Constructors

GRPCIOCallError CallError	Errors that can occur while the call is in flight. These errors come from the core gRPC library directly.
GRPCIOTimeout	Indicates that we timed out while waiting for an operation to complete on the `CompletionQueue`.
GRPCIOShutdown	Indicates that the `CompletionQueue` is shutting down and no more work can be processed. This can happen if the client or server is shutting down.
GRPCIOShutdownFailure	Thrown if a `CompletionQueue` fails to shut down in a reasonable amount of time.
GRPCIOUnknownError
GRPCIOBadStatusCode StatusCode StatusDetails
GRPCIODecodeError String
GRPCIOInternalUnexpectedRecv String
GRPCIOHandlerException String

Instances

Instances details

Eq GRPCIOError
Instance details Defined in Network.GRPC.LowLevel.GRPC Methods (==) :: GRPCIOError -> GRPCIOError -> Bool # (/=) :: GRPCIOError -> GRPCIOError -> Bool #
Show GRPCIOError
Instance details Defined in Network.GRPC.LowLevel.GRPC Methods showsPrec :: Int -> GRPCIOError -> ShowS # show :: GRPCIOError -> String # showList :: [GRPCIOError] -> ShowS #
Exception GRPCIOError
Instance details Defined in Network.GRPC.LowLevel.GRPC Methods toException :: GRPCIOError -> SomeException # fromException :: SomeException -> Maybe GRPCIOError # displayException :: GRPCIOError -> String #

data GRPCImpl Source #

Used at the kind level as a parameter to service definitions generated by the grpc compiler, with the effect of having the field types reduce to the appropriate types for the method types.

Constructors

ServerImpl
ClientImpl

type family MkHandler (impl :: GRPCImpl) (methodType :: GRPCMethodType) i o Source #

GHC does not let us partially apply a type family. However, we can define a type to use as an interpreter, and then use this interpreter type fully applied to get the same effect.

Instances

Instances details

type MkHandler 'ServerImpl 'BiDiStreaming i o Source #
Instance details Defined in Network.GRPC.HighLevel.Generated type MkHandler 'ServerImpl 'BiDiStreaming i o = ServerRWHandler i o
type MkHandler 'ServerImpl 'ServerStreaming i o Source #
Instance details Defined in Network.GRPC.HighLevel.Generated type MkHandler 'ServerImpl 'ServerStreaming i o = ServerWriterHandler i o
type MkHandler 'ServerImpl 'ClientStreaming i o Source #
Instance details Defined in Network.GRPC.HighLevel.Generated type MkHandler 'ServerImpl 'ClientStreaming i o = ServerReaderHandler i o
type MkHandler 'ServerImpl 'Normal i o Source #
Instance details Defined in Network.GRPC.HighLevel.Generated type MkHandler 'ServerImpl 'Normal i o = ServerHandler i o

data ServiceOptions Source #

Options for a service that was generated from a .proto file. This is essentially ServerOptions with the handler fields removed.

Constructors

ServiceOptions

Fields

serverHost :: Host
Name of the host the server is running on.
serverPort :: Port
Port on which to listen for requests.
useCompression :: Bool
Whether to use compression when communicating with the client.
userAgentPrefix :: String
Optional custom prefix to add to the user agent string.
userAgentSuffix :: String
Optional custom suffix to add to the user agent string.
initialMetadata :: MetadataMap
Metadata to send at the beginning of each call.
sslConfig :: Maybe ServerSSLConfig
Security configuration.
logger :: String -> IO ()
Logging function to use to log errors in handling calls.
serverMaxReceiveMessageLength :: Maybe Natural
Maximum length (in bytes) that the service may receive in a single message

Server

data Handler (a :: GRPCMethodType) where Source #

Constructors

UnaryHandler :: (Message c, Message d) => MethodName -> ServerHandler c d -> Handler 'Normal
ClientStreamHandler :: (Message c, Message d) => MethodName -> ServerReaderHandler c d -> Handler 'ClientStreaming
ServerStreamHandler :: (Message c, Message d) => MethodName -> ServerWriterHandler c d -> Handler 'ServerStreaming
BiDiStreamHandler :: (Message c, Message d) => MethodName -> ServerRWHandler c d -> Handler 'BiDiStreaming

data ServerOptions Source #

Constructors

ServerOptions

Fields

optNormalHandlers :: [Handler 'Normal]
Handlers for unary (non-streaming) calls.
optClientStreamHandlers :: [Handler 'ClientStreaming]
Handlers for client streaming calls.
optServerStreamHandlers :: [Handler 'ServerStreaming]
Handlers for server streaming calls.
optBiDiStreamHandlers :: [Handler 'BiDiStreaming]
Handlers for bidirectional streaming calls.
optServerHost :: Host
Name of the host the server is running on.
optServerPort :: Port
Port on which to listen for requests.
optUseCompression :: Bool
Whether to use compression when communicating with the client.
optUserAgentPrefix :: String
Optional custom prefix to add to the user agent string.
optUserAgentSuffix :: String
Optional custom suffix to add to the user agent string.
optInitialMetadata :: MetadataMap
Metadata to send at the beginning of each call.
optSSLConfig :: Maybe ServerSSLConfig
Security configuration.
optLogger :: String -> IO ()
Logging function to use to log errors in handling calls.
optMaxReceiveMessageLength :: Maybe Natural

defaultOptions :: ServerOptions Source #

serverLoop :: ServerOptions -> IO () Source #

data ServerCall a #

Represents one registered GRPC call on the server. Contains pointers to all the C state needed to respond to a registered call.

Constructors

ServerCall
Fields unsafeSC :: Call callCQ :: CompletionQueue metadata :: MetadataMap payload :: a callDeadline :: TimeSpec

Instances

Instances details

Functor ServerCall
Instance details Defined in Network.GRPC.LowLevel.Call Methods fmap :: (a -> b) -> ServerCall a -> ServerCall b # (<$) :: a -> ServerCall b -> ServerCall a #
Show a => Show (ServerCall a)
Instance details Defined in Network.GRPC.LowLevel.Call Methods showsPrec :: Int -> ServerCall a -> ShowS # show :: ServerCall a -> String # showList :: [ServerCall a] -> ShowS #

serverCallCancel :: ServerCall a -> StatusCode -> String -> IO () #

serverCallIsExpired :: ServerCall a -> IO Bool #

Client

data NormalRequestResult #

Constructors

NormalRequestResult
Fields rspBody :: ByteString initMD :: MetadataMap initial metadata trailMD :: MetadataMap trailing metadata rspCode :: StatusCode details :: StatusDetails

Instances

Instances details

Eq NormalRequestResult
Instance details Defined in Network.GRPC.LowLevel.Client Methods (==) :: NormalRequestResult -> NormalRequestResult -> Bool # (/=) :: NormalRequestResult -> NormalRequestResult -> Bool #
Show NormalRequestResult
Instance details Defined in Network.GRPC.LowLevel.Client Methods showsPrec :: Int -> NormalRequestResult -> ShowS # show :: NormalRequestResult -> String # showList :: [NormalRequestResult] -> ShowS #

data ClientCall #

Represents one GRPC call (i.e. request) on the client. This is used to associate send/receive Ops with a request.

clientCallCancel :: ClientCall -> IO () #

Client and Server Auth

data AuthContext #

Context for auth. This is essentially just a set of key-value pairs that can be mutated. Note: it appears that any keys set or modified on this object do not appear in the AuthContext of the peer, so you must send along auth info in the metadata. It's currently unclear to us what the purpose of modifying this is, but we offer the ability for the sake of completeness.

Instances

Instances details

Show AuthContext
Instance details Defined in Network.GRPC.Unsafe.Security Methods showsPrec :: Int -> AuthContext -> ShowS # show :: AuthContext -> String # showList :: [AuthContext] -> ShowS #
Storable AuthContext
Instance details Defined in Network.GRPC.Unsafe.Security Methods sizeOf :: AuthContext -> Int # alignment :: AuthContext -> Int # peekElemOff :: Ptr AuthContext -> Int -> IO AuthContext # pokeElemOff :: Ptr AuthContext -> Int -> AuthContext -> IO () # peekByteOff :: Ptr b -> Int -> IO AuthContext # pokeByteOff :: Ptr b -> Int -> AuthContext -> IO () # peek :: Ptr AuthContext -> IO AuthContext # poke :: Ptr AuthContext -> AuthContext -> IO () #

data AuthProperty #

Represents one key/value pair in an AuthContext.

Constructors

AuthProperty
Fields authPropName :: ByteString authPropValue :: ByteString

Instances

Instances details

Eq AuthProperty
Instance details Defined in Network.GRPC.Unsafe.Security Methods (==) :: AuthProperty -> AuthProperty -> Bool # (/=) :: AuthProperty -> AuthProperty -> Bool #
Show AuthProperty
Instance details Defined in Network.GRPC.Unsafe.Security Methods showsPrec :: Int -> AuthProperty -> ShowS # show :: AuthProperty -> String # showList :: [AuthProperty] -> ShowS #

getAuthProperties :: AuthContext -> IO [AuthProperty] #

addAuthProperty :: AuthContext -> AuthProperty -> IO () #

Adds a new property to the given AuthContext.

Server Auth

data ServerSSLConfig #

Configuration for SSL.

Constructors

ServerSSLConfig
Fields clientRootCert :: Maybe FilePath serverPrivateKey :: FilePath serverCert :: FilePath clientCertRequest :: SslClientCertificateRequestType Whether to request a certificate from the client, and what to do with it if received. customMetadataProcessor :: Maybe ProcessMeta

type ProcessMeta = AuthContext -> MetadataMap -> IO AuthProcessorResult #

A custom auth metadata processor. This can be used to implement customized auth schemes based on the metadata in the request.

data AuthProcessorResult #

Constructors

AuthProcessorResult

Fields

resultConsumedMetadata :: MetadataMap
Metadata to remove from the request before passing to the handler.
resultResponseMetadata :: MetadataMap
Metadata to add to the response.
resultStatus :: StatusCode
StatusOk if auth was successful. Using any other status code here will cause the request to be rejected without reaching a handler. For rejected requests, it's suggested that this be StatusUnauthenticated or StatusPermissionDenied. NOTE: if you are using the low-level interface and the request is rejected, then handling functions in the low-level interface such as serverHandleNormalCall will not unblock until they receive another request that is not rejected. So, if you write a buggy auth plugin that rejects all requests, your server could hang.
resultStatusDetails :: StatusDetails

data SslClientCertificateRequestType #

Constructors

SslDontRequestClientCertificate
SslRequestClientCertificateButDontVerify
SslRequestClientCertificateAndVerify
SslRequestAndRequireClientCertificateButDontVerify
SslRequestAndRequireClientCertificateAndVerify

Instances

Instances details

Bounded SslClientCertificateRequestType
Instance details Defined in Network.GRPC.Unsafe.Security Methods minBound :: SslClientCertificateRequestType # maxBound :: SslClientCertificateRequestType #
Enum SslClientCertificateRequestType
Instance details Defined in Network.GRPC.Unsafe.Security Methods succ :: SslClientCertificateRequestType -> SslClientCertificateRequestType # pred :: SslClientCertificateRequestType -> SslClientCertificateRequestType # toEnum :: Int -> SslClientCertificateRequestType # fromEnum :: SslClientCertificateRequestType -> Int # enumFrom :: SslClientCertificateRequestType -> [SslClientCertificateRequestType] # enumFromThen :: SslClientCertificateRequestType -> SslClientCertificateRequestType -> [SslClientCertificateRequestType] # enumFromTo :: SslClientCertificateRequestType -> SslClientCertificateRequestType -> [SslClientCertificateRequestType] # enumFromThenTo :: SslClientCertificateRequestType -> SslClientCertificateRequestType -> SslClientCertificateRequestType -> [SslClientCertificateRequestType] #
Eq SslClientCertificateRequestType
Instance details Defined in Network.GRPC.Unsafe.Security Methods (==) :: SslClientCertificateRequestType -> SslClientCertificateRequestType -> Bool # (/=) :: SslClientCertificateRequestType -> SslClientCertificateRequestType -> Bool #
Ord SslClientCertificateRequestType
Instance details Defined in Network.GRPC.Unsafe.Security Methods compare :: SslClientCertificateRequestType -> SslClientCertificateRequestType -> Ordering # (<) :: SslClientCertificateRequestType -> SslClientCertificateRequestType -> Bool # (<=) :: SslClientCertificateRequestType -> SslClientCertificateRequestType -> Bool # (>) :: SslClientCertificateRequestType -> SslClientCertificateRequestType -> Bool # (>=) :: SslClientCertificateRequestType -> SslClientCertificateRequestType -> Bool # max :: SslClientCertificateRequestType -> SslClientCertificateRequestType -> SslClientCertificateRequestType # min :: SslClientCertificateRequestType -> SslClientCertificateRequestType -> SslClientCertificateRequestType #
Show SslClientCertificateRequestType
Instance details Defined in Network.GRPC.Unsafe.Security Methods showsPrec :: Int -> SslClientCertificateRequestType -> ShowS # show :: SslClientCertificateRequestType -> String # showList :: [SslClientCertificateRequestType] -> ShowS #

Client Auth

data ClientSSLConfig #

SSL configuration for the client. It's perfectly acceptable for both fields to be Nothing, in which case default fallbacks will be used for the server root cert.

Constructors

ClientSSLConfig
Fields serverRootCert :: Maybe FilePath Path to the server root certificate. If `Nothing`, gRPC will attempt to fall back to a default. clientSSLKeyCertPair :: Maybe ClientSSLKeyCertPair The client's private key and cert, if available. clientMetadataPlugin :: Maybe ClientMetadataCreate Optional plugin for attaching additional metadata to each call.

data ClientSSLKeyCertPair #

Constructors

ClientSSLKeyCertPair
Fields clientPrivateKey :: FilePath clientCert :: FilePath

Instances

Instances details

Show ClientSSLKeyCertPair
Instance details Defined in Network.GRPC.LowLevel.Client Methods showsPrec :: Int -> ClientSSLKeyCertPair -> ShowS # show :: ClientSSLKeyCertPair -> String # showList :: [ClientSSLKeyCertPair] -> ShowS #

type ClientMetadataCreate = AuthMetadataContext -> IO ClientMetadataCreateResult #

Optional plugin for attaching custom auth metadata to each call.

data ClientMetadataCreateResult #

Constructors

ClientMetadataCreateResult
Fields clientResultMetadata :: MetadataMap Additional metadata to add to the call. clientResultStatus :: StatusCode if not `StatusOk`, causes the call to fail with the given status code. NOTE: if the auth fails, the call will not get sent to the server. So, if you're writing a test, your server might wait for a request forever. clientResultDetails :: StatusDetails

data AuthMetadataContext #

The context which a client-side auth metadata plugin sees when it runs.

Constructors

AuthMetadataContext
Fields serviceURL :: ByteString The URL of the service the current call is going to. methodName :: ByteString The method that is being invoked with the current call. It appears that the gRPC 0.15 core is not populating this correctly, because it's an empty string in my tests so far. channelAuthContext :: AuthContext

Instances

Instances details

Show AuthMetadataContext
Instance details Defined in Network.GRPC.Unsafe.Security Methods showsPrec :: Int -> AuthMetadataContext -> ShowS # show :: AuthMetadataContext -> String # showList :: [AuthMetadataContext] -> ShowS #

Streaming utilities

type StreamSend a = a -> IO (Either GRPCIOError ()) #

type StreamRecv a = IO (Either GRPCIOError (Maybe a)) #