Safe Haskell	None
Language	Haskell2010

Cardano.Wallet.Registry

Contents

Worker Registry
Worker
Context
Logging

Synopsis

data WorkerRegistry key resource
empty :: Ord key => IO ( WorkerRegistry key resource)
lookup :: ( MonadIO m, Ord key) => WorkerRegistry key resource -> key -> m ( Maybe ( Worker key resource))
register :: forall resource ctx key msg. ( Ord key, key ~ WorkerKey ctx, msg ~ WorkerMsg ctx, HasLogger IO ( WorkerLog key msg) ctx, HasWorkerCtx resource ctx) => WorkerRegistry key resource -> ctx -> key -> MkWorker key resource msg ctx -> IO ( Maybe ( Worker key resource))
unregister :: Ord key => WorkerRegistry key resource -> key -> IO ()
data Worker key resource
data MkWorker key resource msg ctx = MkWorker {
- workerBefore :: WorkerCtx ctx -> key -> IO ()
- workerMain :: WorkerCtx ctx -> key -> IO ()
- workerAfter :: Tracer IO ( WorkerLog key msg) -> Either SomeException () -> IO ()
- workerAcquire :: (resource -> IO ()) -> IO ()
}
defaultWorkerAfter :: Tracer IO ( WorkerLog key msg) -> Either SomeException a -> IO ()
workerThread :: Worker key resource -> ThreadId
workerId :: Worker key resource -> key
workerResource :: Worker key resource -> resource
class HasType resource ( WorkerCtx ctx) => HasWorkerCtx resource ctx where
- type WorkerCtx ctx :: Type
- type WorkerMsg ctx :: Type
- type WorkerKey ctx :: Type
- hoistResource :: resource -> ( WorkerMsg ctx -> WorkerLog ( WorkerKey ctx) ( WorkerMsg ctx)) -> ctx -> WorkerCtx ctx
data WorkerLog key msg
- = MsgThreadAfter AfterThreadLog
- | MsgFromWorker key msg
data AfterThreadLog
- = MsgThreadFinished
- | MsgThreadCancelled
- | MsgUnhandledException ( LoggedException SomeException )
traceAfterThread :: Tracer m AfterThreadLog -> Either SomeException a -> m ()

Worker Registry

data WorkerRegistry key resource Source #

A registry to keep track of worker threads and acquired resources.

empty :: Ord key => IO ( WorkerRegistry key resource) Source #

Construct a new empty registry

lookup :: ( MonadIO m, Ord key) => WorkerRegistry key resource -> key -> m ( Maybe ( Worker key resource)) Source #

Lookup the registry for a given worker

register :: forall resource ctx key msg. ( Ord key, key ~ WorkerKey ctx, msg ~ WorkerMsg ctx, HasLogger IO ( WorkerLog key msg) ctx, HasWorkerCtx resource ctx) => WorkerRegistry key resource -> ctx -> key -> MkWorker key resource msg ctx -> IO ( Maybe ( Worker key resource)) Source #

Register a new worker for a given key.

A worker maintains an acquired resource. It expects a task as an argument and will terminate as soon as its task is over. In practice, we provide a never-ending task that keeps the worker alive forever.

Returns Nothing if the worker fails to acquire the necessary resource or terminates unexpectedly before entering its main action.

unregister :: Ord key => WorkerRegistry key resource -> key -> IO () Source #

Unregister a worker from the registry, terminating the running task.

Worker

data Worker key resource Source #

A worker which holds and manipulate a particular acquired resource. That resource can be, for example, a handle to a database connection.

Instances

Instances details

Generic ( Worker key resource) Source #
Instance details Defined in Cardano.Wallet.Registry Associated Types type Rep ( Worker key resource) :: Type -> Type Source # Methods from :: Worker key resource -> Rep ( Worker key resource) x Source # to :: Rep ( Worker key resource) x -> Worker key resource Source #
type Rep ( Worker key resource) Source #
Instance details Defined in Cardano.Wallet.Registry type Rep ( Worker key resource) = D1 (' MetaData "Worker" "Cardano.Wallet.Registry" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "Worker" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "workerId") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 key) :: ( S1 (' MetaSel (' Just "workerThread") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ThreadId ) :: S1 (' MetaSel (' Just "workerResource") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 resource))))

data MkWorker key resource msg ctx Source #

See register

Constructors

MkWorker

Fields

workerBefore :: WorkerCtx ctx -> key -> IO ()

A task to execute before the main worker's task. When creating a worker, this task is guaranteed to have terminated once register returns.
workerMain :: WorkerCtx ctx -> key -> IO ()

A task for the worker, possibly infinite
workerAfter :: Tracer IO ( WorkerLog key msg) -> Either SomeException () -> IO ()

Action to run when the worker exits. It will be run * when the workerMain action exits (successfully or not) * if workerAcquire fails * or if the workerBefore action throws an exception.
workerAcquire :: (resource -> IO ()) -> IO ()

A bracket-style factory to acquire a resource

defaultWorkerAfter :: Tracer IO ( WorkerLog key msg) -> Either SomeException a -> IO () Source #

workerThread :: Worker key resource -> ThreadId Source #

workerId :: Worker key resource -> key Source #

workerResource :: Worker key resource -> resource Source #

Context

class HasType resource ( WorkerCtx ctx) => HasWorkerCtx resource ctx where Source #

A class to link an existing context to a worker context.

Associated Types

type WorkerCtx ctx :: Type Source #

type WorkerMsg ctx :: Type Source #

type WorkerKey ctx :: Type Source #

Methods

hoistResource :: resource -> ( WorkerMsg ctx -> WorkerLog ( WorkerKey ctx) ( WorkerMsg ctx)) -> ctx -> WorkerCtx ctx Source #

Instances

Instances details

HasWorkerCtx ( DBLayer IO s k) ( ApiLayer s k) Source #
Instance details Defined in Cardano.Wallet.Api Associated Types type WorkerCtx ( ApiLayer s k) Source # type WorkerMsg ( ApiLayer s k) Source # type WorkerKey ( ApiLayer s k) Source # Methods hoistResource :: DBLayer IO s k -> ( WorkerMsg ( ApiLayer s k) -> WorkerLog ( WorkerKey ( ApiLayer s k)) ( WorkerMsg ( ApiLayer s k))) -> ApiLayer s k -> WorkerCtx ( ApiLayer s k) Source #

Logging

data WorkerLog key msg Source #

Log messages relating to a registry worker thread.

Constructors

MsgThreadAfter AfterThreadLog
MsgFromWorker key msg

Instances

Instances details

( Eq key, Eq msg) => Eq ( WorkerLog key msg) Source #
Instance details Defined in Cardano.Wallet.Registry Methods (==) :: WorkerLog key msg -> WorkerLog key msg -> Bool Source # (/=) :: WorkerLog key msg -> WorkerLog key msg -> Bool Source #
( Show key, Show msg) => Show ( WorkerLog key msg) Source #
Instance details Defined in Cardano.Wallet.Registry Methods showsPrec :: Int -> WorkerLog key msg -> ShowS Source # show :: WorkerLog key msg -> String Source # showList :: [ WorkerLog key msg] -> ShowS Source #
( ToText key, ToText msg) => ToText ( WorkerLog key msg) Source #
Instance details Defined in Cardano.Wallet.Registry Methods toText :: WorkerLog key msg -> Text Source #
HasPrivacyAnnotation ( WorkerLog key msg) Source #
Instance details Defined in Cardano.Wallet.Registry Methods getPrivacyAnnotation :: WorkerLog key msg -> PrivacyAnnotation
HasSeverityAnnotation msg => HasSeverityAnnotation ( WorkerLog key msg) Source #
Instance details Defined in Cardano.Wallet.Registry Methods getSeverityAnnotation :: WorkerLog key msg -> Severity

data AfterThreadLog Source #

Log messages describing how a worker thread exits.

Constructors

MsgThreadFinished
MsgThreadCancelled
MsgUnhandledException ( LoggedException SomeException )

Instances

Instances details

Eq AfterThreadLog Source #
Instance details Defined in Cardano.Wallet.Registry Methods (==) :: AfterThreadLog -> AfterThreadLog -> Bool Source # (/=) :: AfterThreadLog -> AfterThreadLog -> Bool Source #
Show AfterThreadLog Source #
Instance details Defined in Cardano.Wallet.Registry Methods showsPrec :: Int -> AfterThreadLog -> ShowS Source # show :: AfterThreadLog -> String Source # showList :: [ AfterThreadLog ] -> ShowS Source #
ToText AfterThreadLog Source #
Instance details Defined in Cardano.Wallet.Registry Methods toText :: AfterThreadLog -> Text Source #
HasPrivacyAnnotation AfterThreadLog Source #
Instance details Defined in Cardano.Wallet.Registry Methods getPrivacyAnnotation :: AfterThreadLog -> PrivacyAnnotation
HasSeverityAnnotation AfterThreadLog Source #
Instance details Defined in Cardano.Wallet.Registry Methods getSeverityAnnotation :: AfterThreadLog -> Severity

traceAfterThread :: Tracer m AfterThreadLog -> Either SomeException a -> m () Source #

Trace an AfterThreadLog message from a caught exception.