Safe Haskell	None
Language	Haskell2010

Network.GRPC.Server.Run

Contents

Configuration
Simple interface
Full interface
Exceptions

Description

Convenience functions for running a HTTP2 server

Intended for unqualified import.

Synopsis

data ServerConfig = ServerConfig {
- serverInsecure :: Maybe InsecureConfig
- serverSecure :: Maybe SecureConfig
}
data InsecureConfig
- = InsecureConfig {
  - insecureHost :: Maybe HostName
  - insecurePort :: PortNumber
  }
- | InsecureUnix {
  - insecurePath :: FilePath
  }
data SecureConfig = SecureConfig {
- secureHost :: HostName
- securePort :: PortNumber
- securePubCert :: FilePath
- secureChainCerts :: [FilePath]
- securePrivKey :: FilePath
- secureSslKeyLog :: SslKeyLog
}
runServer :: HTTP2Settings -> ServerConfig -> Server -> IO ()
runServerWithHandlers :: ServerParams -> ServerConfig -> [SomeRpcHandler IO] -> IO ()
data RunningServer
forkServer :: HTTP2Settings -> ServerConfig -> Server -> (RunningServer -> IO a) -> IO a
waitServer :: RunningServer -> IO ()
waitServerSTM :: RunningServer -> STM (Either SomeException (), Either SomeException ())
getInsecureSocket :: RunningServer -> STM Socket
getSecureSocket :: RunningServer -> STM Socket
getServerSocket :: RunningServer -> STM Socket
getServerPort :: RunningServer -> IO PortNumber
data ServerTerminated = ServerTerminated
data CouldNotLoadCredentials = CouldNotLoadCredentials String

Configuration

data ServerConfig Source #

Server configuration

Describes the configuration of both an insecure server and a secure server. See the documentation of runServer for a description of what servers will result from various configurations.

Constructors

ServerConfig
Fields serverInsecure :: Maybe InsecureConfig Configuration for insecure communication (without TLS) Set to `Nothing` to disable. serverSecure :: Maybe SecureConfig Configuration for secure communication (over TLS) Set to `Nothing` to disable.

Instances

Instances details

Generic ServerConfig Source #

Instance details

Defined in Network.GRPC.Server.Run

Associated Types

type Rep ServerConfig

Instance details

Defined in Network.GRPC.Server.Run

type Rep ServerConfig = D1 ('MetaData "ServerConfig" "Network.GRPC.Server.Run" "grapesy-1.0.1-inplace" 'False) (C1 ('MetaCons "ServerConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverInsecure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InsecureConfig)) :*: S1 ('MetaSel ('Just "serverSecure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SecureConfig))))

Methods

from :: ServerConfig -> Rep ServerConfig x #

to :: Rep ServerConfig x -> ServerConfig #

Show ServerConfig Source #

Instance details

Defined in Network.GRPC.Server.Run

Methods

showsPrec :: Int -> ServerConfig -> ShowS #

show :: ServerConfig -> String #

showList :: [ServerConfig] -> ShowS #

type Rep ServerConfig Source #

Instance details

Defined in Network.GRPC.Server.Run

type Rep ServerConfig = D1 ('MetaData "ServerConfig" "Network.GRPC.Server.Run" "grapesy-1.0.1-inplace" 'False) (C1 ('MetaCons "ServerConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverInsecure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InsecureConfig)) :*: S1 ('MetaSel ('Just "serverSecure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SecureConfig))))

data InsecureConfig Source #

Offer insecure connection (no TLS)

Constructors

InsecureConfig	Insecure TCP connection
Fields insecureHost :: Maybe HostName Hostname insecurePort :: PortNumber Port number Can use `0` to let the server pick its own port. This can be useful in testing scenarios; see `getServerPort` or the more general `getInsecureSocket` for a way to figure out what this port actually is.
InsecureUnix	Insecure (but local) Unix domain socket connection
Fields insecurePath :: FilePath Path to the socket

Instances

Instances details

Generic InsecureConfig Source #

Instance details

Defined in Network.GRPC.Server.Run

Associated Types

type Rep InsecureConfig

Instance details

Defined in Network.GRPC.Server.Run

type Rep InsecureConfig = D1 ('MetaData "InsecureConfig" "Network.GRPC.Server.Run" "grapesy-1.0.1-inplace" 'False) (C1 ('MetaCons "InsecureConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "insecureHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe HostName)) :*: S1 ('MetaSel ('Just "insecurePort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PortNumber)) :+: C1 ('MetaCons "InsecureUnix" 'PrefixI 'True) (S1 ('MetaSel ('Just "insecurePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))

Methods

from :: InsecureConfig -> Rep InsecureConfig x #

to :: Rep InsecureConfig x -> InsecureConfig #

Show InsecureConfig Source #

Instance details

Defined in Network.GRPC.Server.Run

Methods

showsPrec :: Int -> InsecureConfig -> ShowS #

show :: InsecureConfig -> String #

showList :: [InsecureConfig] -> ShowS #

type Rep InsecureConfig Source #

Instance details

Defined in Network.GRPC.Server.Run

type Rep InsecureConfig = D1 ('MetaData "InsecureConfig" "Network.GRPC.Server.Run" "grapesy-1.0.1-inplace" 'False) (C1 ('MetaCons "InsecureConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "insecureHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe HostName)) :*: S1 ('MetaSel ('Just "insecurePort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PortNumber)) :+: C1 ('MetaCons "InsecureUnix" 'PrefixI 'True) (S1 ('MetaSel ('Just "insecurePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))

data SecureConfig Source #

Offer secure connection (over TLS)

Constructors

SecureConfig

Fields

secureHost :: HostName
Hostname to bind to
Unlike in InsecureConfig, the HostName is required here, because it must match the certificate.
This doesn't need to match the common name (CN) in the TLS certificate. For example, if the client connects to 127.0.0.1, and the certificate CN is also 127.0.0.1, the server can still bind to 0.0.0.0.
securePort :: PortNumber
Port number
See insecurePort for additional discussion.
securePubCert :: FilePath
TLS public certificate (X.509 format)
secureChainCerts :: [FilePath]
TLS chain certificates (X.509 format)
securePrivKey :: FilePath
TLS private key
secureSslKeyLog :: SslKeyLog
SSL key log

Instances

Instances details

Generic SecureConfig Source #

Instance details

Defined in Network.GRPC.Server.Run

Associated Types

type Rep SecureConfig

Instance details

Defined in Network.GRPC.Server.Run

type Rep SecureConfig = D1 ('MetaData "SecureConfig" "Network.GRPC.Server.Run" "grapesy-1.0.1-inplace" 'False) (C1 ('MetaCons "SecureConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "secureHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HostName) :*: (S1 ('MetaSel ('Just "securePort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PortNumber) :*: S1 ('MetaSel ('Just "securePubCert") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath))) :*: (S1 ('MetaSel ('Just "secureChainCerts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: (S1 ('MetaSel ('Just "securePrivKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Just "secureSslKeyLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SslKeyLog)))))

Methods

from :: SecureConfig -> Rep SecureConfig x #

to :: Rep SecureConfig x -> SecureConfig #

Show SecureConfig Source #

Instance details

Defined in Network.GRPC.Server.Run

Methods

showsPrec :: Int -> SecureConfig -> ShowS #

show :: SecureConfig -> String #

showList :: [SecureConfig] -> ShowS #

type Rep SecureConfig Source #

Instance details

Defined in Network.GRPC.Server.Run

type Rep SecureConfig = D1 ('MetaData "SecureConfig" "Network.GRPC.Server.Run" "grapesy-1.0.1-inplace" 'False) (C1 ('MetaCons "SecureConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "secureHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HostName) :*: (S1 ('MetaSel ('Just "securePort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PortNumber) :*: S1 ('MetaSel ('Just "securePubCert") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath))) :*: (S1 ('MetaSel ('Just "secureChainCerts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: (S1 ('MetaSel ('Just "securePrivKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Just "secureSslKeyLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SslKeyLog)))))

Simple interface

runServer :: HTTP2Settings -> ServerConfig -> Server -> IO () Source #

Run a Server with the given ServerConfig.

If both configurations are disabled, runServer will simply immediately return. If both configurations are enabled, then two servers will be run concurrently; one with the insecure configuration and the other with the secure configuration. Obviously, if only one of the configurations is enabled, then just that server will be run.

See also runServerWithHandlers, which handles the creation of the Server for you.

runServerWithHandlers :: ServerParams -> ServerConfig -> [SomeRpcHandler IO] -> IO () Source #

Convenience function that combines runServer with mkGrpcServer

NOTE: If you want to override the HTTP2Settings, use runServer instead.

Full interface

data RunningServer Source #

forkServer :: HTTP2Settings -> ServerConfig -> Server -> (RunningServer -> IO a) -> IO a Source #

Start the server

waitServer :: RunningServer -> IO () Source #

IO version of waitServerSTM that rethrows exceptions

waitServerSTM :: RunningServer -> STM (Either SomeException (), Either SomeException ()) Source #

Wait for the server to terminate

Returns the results of the insecure and secure servers separately. Note that under normal circumstances the server never terminates.

getInsecureSocket :: RunningServer -> STM Socket Source #

Get the socket used by the insecure server

The socket is created as the server initializes; this function will block until that is complete. However:

If the server throws an exception, that exception is rethrown here.
If the server has already terminated, we throw ServerTerminated
If the insecure server was not enabled, it is considered to have terminated immediately and the same ServerTerminated exception is thrown.

getSecureSocket :: RunningServer -> STM Socket Source #

Get the socket used by the secure server

Similar remarks apply as for getInsecureSocket.

getServerSocket :: RunningServer -> STM Socket Source #

Get "the" socket associated with the server

Precondition: only one server must be enabled (secure or insecure).

getServerPort :: RunningServer -> IO PortNumber Source #

Get "the" port number used by the server

Precondition: only one server must be enabled (secure or insecure).

Exceptions

data ServerTerminated Source #

Constructors

ServerTerminated

Instances

Instances details

Exception ServerTerminated Source #
Instance details Defined in Network.GRPC.Server.Run Methods toException :: ServerTerminated -> SomeException # fromException :: SomeException -> Maybe ServerTerminated # displayException :: ServerTerminated -> String # backtraceDesired :: ServerTerminated -> Bool #
Show ServerTerminated Source #
Instance details Defined in Network.GRPC.Server.Run Methods showsPrec :: Int -> ServerTerminated -> ShowS # show :: ServerTerminated -> String # showList :: [ServerTerminated] -> ShowS #

data CouldNotLoadCredentials Source #

Constructors

CouldNotLoadCredentials String

Failed to load server credentials

Instances

Instances details

Exception CouldNotLoadCredentials Source #
Instance details Defined in Network.GRPC.Server.Run Methods toException :: CouldNotLoadCredentials -> SomeException # fromException :: SomeException -> Maybe CouldNotLoadCredentials # displayException :: CouldNotLoadCredentials -> String # backtraceDesired :: CouldNotLoadCredentials -> Bool #
Show CouldNotLoadCredentials Source #
Instance details Defined in Network.GRPC.Server.Run Methods showsPrec :: Int -> CouldNotLoadCredentials -> ShowS # show :: CouldNotLoadCredentials -> String # showList :: [CouldNotLoadCredentials] -> ShowS #