Modulegrapesy-1.1.1Haskell2010

Network.GRPC.Server.Run

Convenience functions for running a HTTP2 server

Intended for unqualified import.

6 types
9 values

Packagegrapesy-1.1.1
Exports15
LanguageHaskell2010
LicenceBSD-3-Clause
SourceRun.hs

Configuration

3 declarations

datadata ServerConfig

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
- 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.

Instances3Show, Generic, Rep

Show ServerConfigDefined in grapesy-1.1.1 · Network.GRPC.Server.Run
Generic ServerConfigDefined in grapesy-1.1.1 · Network.GRPC.Server.Run
type Rep ServerConfig = D1 ('MetaData "ServerConfig" "Network.GRPC.Server.Run" "grapesy-1.1.1-EqYFDgiPoEPCSqHO68COW4" '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))))Defined in grapesy-1.1.1 · Network.GRPC.Server.Run

datadata InsecureConfig

Offer insecure connection (no TLS)

Constructors

InsecureConfig
Insecure TCP connection
- 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
- insecurePath :: FilePath
  Path to the socket

Instances3Show, Generic, Rep

Show InsecureConfigDefined in grapesy-1.1.1 · Network.GRPC.Server.Run
Generic InsecureConfigDefined in grapesy-1.1.1 · Network.GRPC.Server.Run
type Rep InsecureConfig = D1 ('MetaData "InsecureConfig" "Network.GRPC.Server.Run" "grapesy-1.1.1-EqYFDgiPoEPCSqHO68COW4" '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)))Defined in grapesy-1.1.1 · Network.GRPC.Server.Run

datadata SecureConfig

Offer secure connection (over TLS)

Constructors

SecureConfig
- 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

Instances3Show, Generic, Rep

Show SecureConfigDefined in grapesy-1.1.1 · Network.GRPC.Server.Run
Generic SecureConfigDefined in grapesy-1.1.1 · Network.GRPC.Server.Run
type Rep SecureConfig = D1 ('MetaData "SecureConfig" "Network.GRPC.Server.Run" "grapesy-1.1.1-EqYFDgiPoEPCSqHO68COW4" '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)))))Defined in grapesy-1.1.1 · Network.GRPC.Server.Run

Simple interface

2 declarations

valuerunServer :: HTTP2Settings -> ServerConfig -> Server -> IO ()

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.

valuerunServerWithHandlers

:: ServerParams
-> ServerConfig
-> [SomeRpcHandler IO]
-> IO ()

Convenience function that combines runServer with mkGrpcServer

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

Full interface

8 declarations

datadata RunningServer

valueforkServer

:: HTTP2Settings
-> ServerConfig
-> Server
-> RunningServer -> IO a
-> IO a

Start the server

valuewaitServer :: RunningServer -> IO ()

IO version of waitServerSTM that rethrows exceptions

valuewaitServerSTM

:: RunningServer
-> STM (Either SomeException (), Either SomeException ())

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.

valuegetInsecureSocket :: RunningServer -> STM Socket

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.

valuegetSecureSocket :: RunningServer -> STM Socket

Get the socket used by the secure server

Similar remarks apply as for getInsecureSocket.

valuegetServerSocket :: RunningServer -> STM Socket

Get "the" socket associated with the server

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

valuegetServerPort :: RunningServer -> IO PortNumber

Get "the" port number used by the server

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

Exceptions

2 declarations

datadata ServerTerminated

ServerTerminated

Instances2Show, Exception

Show ServerTerminatedDefined in grapesy-1.1.1 · Network.GRPC.Server.Run
Exception ServerTerminatedDefined in grapesy-1.1.1 · Network.GRPC.Server.Run

datadata CouldNotLoadCredentials

Constructors

CouldNotLoadCredentials String
Failed to load server credentials

Instances2Show, Exception

Show CouldNotLoadCredentialsDefined in grapesy-1.1.1 · Network.GRPC.Server.Run
Exception CouldNotLoadCredentialsDefined in grapesy-1.1.1 · Network.GRPC.Server.Run