Modulekes-agent-1.3.0.0Haskell2010

Cardano.KESAgent.Processes.ServiceClient

KES agent service client API

Synopsis

data ServiceClientTrace
class ServiceClientDrivers
data ServiceClientOptions
type ServiceClientCrypto
type MonadServiceClient
type ServiceClientContext
value runServiceClientForever
value runServiceClient

Packagekes-agent-1.3.0.0
Exports8
LanguageHaskell2010
LicenceApache-2.0
SourceServiceClient.hs

datadata ServiceClientTrace

Source#

Trace logging messages a service client can generate.

Instances2Show, Pretty

Show ServiceClientTraceDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.ServiceClient
Pretty ServiceClientTraceDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.ServiceClient

classclass ServiceClientDrivers c where

Source#

Crypto types for which service client drivers are available.

Methods

availableServiceClientDrivers :: ServiceClientContext m c => [(VersionIdentifier, RawBearer m -> Tracer m ServiceClientTrace -> (TaggedBundle m c -> m RecvResult) -> m ())]

Instances3ServiceClientDrivers

ServiceClientDrivers MockCryptoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.ServiceClient
ServiceClientDrivers SingleCryptoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.ServiceClient
ServiceClientDrivers StandardCryptoDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Processes.ServiceClient

datadata ServiceClientOptions (m :: Type -> Type) fd addr

Source#

Configuration options for a service client.

Constructors

ServiceClientOptions
- serviceClientSnocket :: Snocket m fd addr
  Snocket implementation to use for socket operations
- serviceClientAddress :: addr
  Socket address to connect to. A KES agent should be listening for service connections here.

type

type ServiceClientCrypto c = (Crypto c, NamedCrypto c, Typeable c, ServiceClientDrivers c, DirectSerialise (SignKeyKES (KES c)), DirectDeserialise (SignKeyKES (KES c)))

Source#

Crypto types that support service client operations.

type

type MonadServiceClient (m :: Type -> Type) = (Monad m, MonadEvaluate m, MonadFail m, MonadThrow m, MonadCatch m, MonadDelay m, MonadST m, MonadSTM m, MonadMVar m)

Source#

Monadic typeclasses required to run service client actions.

typetype ServiceClientContext (m :: Type -> Type) c = (MonadServiceClient m, ServiceClientCrypto c)

Source#

Typeclasses required for running service clients against a given crypto.

valuerunServiceClientForever

:: (ServiceClientContext m c, Show addr)
=> Proxy c
-> MakeRawBearer m fd
-> ServiceClientOptions m fd addr
-> TaggedBundle m c -> m RecvResult
-> Tracer m ServiceClientTrace
-> m ()

Source#

Run a service client indefinitely, restarting the connection once a session ends. In case of an abnormal session termination (via an exception), the exception is logged via the provided Tracer, and another connection attempt is made.

valuerunServiceClient

:: (ServiceClientContext m c, Show addr)
=> Proxy c
-> MakeRawBearer m fd
-> ServiceClientOptions m fd addr
-> TaggedBundle m c -> m RecvResult
-> Tracer m ServiceClientTrace
-> m ()

Source#

Run a single service client session. Once the peer closes the connection, or a failure occurs, return.