| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Ouroboros.Network.Subscription.Worker
Synopsis
- type SocketStateChange m s addr = SocketState m addr → s → STM m s
- data SocketState m addr
- = CreatedSocket !addr !(Async m ())
- | ClosedSocket !addr !(Async m ())
- type CompleteApplication m s addr r = Result addr r → s → STM m (CompleteApplicationResult m addr s)
- data ConnectResult
- data Result addr r where
- ApplicationResult ∷ !Time → !addr → !r → Result addr r
- Connected ∷ !Time → !addr → Result addr r
- ConnectionError ∷ Exception e ⇒ !Time → !addr → !e → Result addr r
- ApplicationError ∷ Exception e ⇒ !Time → !addr → !e → Result addr r
- type Main m s t = s → STM m t
- type StateVar m s = StrictTVar m s
- data LocalAddresses addr = LocalAddresses {}
- data WorkerCallbacks m s addr a t = WorkerCallbacks {
- wcSocketStateChangeTx ∷ SocketStateChange m s addr
- wcCompleteApplicationTx ∷ CompleteApplication m s addr a
- wcMainTx ∷ Main m s t
- data WorkerParams m localAddrs addr = WorkerParams {
- wpLocalAddresses ∷ localAddrs addr
- wpSelectAddress ∷ addr → localAddrs addr → Maybe addr
- wpConnectionAttemptDelay ∷ addr → Maybe DiffTime
- wpSubscriptionTarget ∷ m (SubscriptionTarget m addr)
- wpValency ∷ Int
- worker ∷ ∀ s sock localAddrs addr a x. Ord addr ⇒ Tracer IO (SubscriptionTrace addr) → Tracer IO (WithAddr addr ErrorPolicyTrace) → ConnectionTable IO addr → StateVar IO s → Snocket IO sock addr → (sock → addr → IO ()) → WorkerCallbacks IO s addr a x → WorkerParams IO localAddrs addr → (sock → IO a) → IO x
- safeConnect ∷ MonadMask m ⇒ Snocket m sock addr → (sock → addr → m ()) → addr → addr → m () → m () → ((∀ x. m x → m x) → sock → Either SomeException () → m t) → m t
- defaultConnectionAttemptDelay ∷ DiffTime
- minConnectionAttemptDelay ∷ DiffTime
- maxConnectionAttemptDelay ∷ DiffTime
- ipRetryDelay ∷ DiffTime
- data SubscriberError = SubscriberError {}
- data SubscriptionTrace addr
- = SubscriptionTraceConnectStart addr
- | SubscriptionTraceConnectEnd addr ConnectResult
- | ∀ e.Exception e ⇒ SubscriptionTraceSocketAllocationException addr e
- | ∀ e.Exception e ⇒ SubscriptionTraceConnectException addr e
- | ∀ e.Exception e ⇒ SubscriptionTraceApplicationException addr e
- | SubscriptionTraceTryConnectToPeer addr
- | SubscriptionTraceSkippingPeer addr
- | SubscriptionTraceSubscriptionRunning
- | SubscriptionTraceSubscriptionWaiting Int
- | SubscriptionTraceSubscriptionFailed
- | SubscriptionTraceSubscriptionWaitingNewConnection DiffTime
- | SubscriptionTraceStart Int
- | SubscriptionTraceRestart DiffTime Int Int
- | SubscriptionTraceConnectionExist addr
- | SubscriptionTraceUnsupportedRemoteAddr addr
- | SubscriptionTraceMissingLocalAddress
- | SubscriptionTraceAllocateSocket addr
- | SubscriptionTraceCloseSocket addr
Documentation
type SocketStateChange m s addr = SocketState m addr → s → STM m s Source #
Callback which fires: when we create or close a socket.
data SocketState m addr Source #
Constructors
| CreatedSocket !addr !(Async m ()) | |
| ClosedSocket !addr !(Async m ()) |
type CompleteApplication m s addr r = Result addr r → s → STM m (CompleteApplicationResult m addr s) Source #
Complete a connection, which receive application result (or exception).
data ConnectResult Source #
GADT which classifies connection result.
Constructors
| ConnectSuccess | Successful connection. |
| ConnectSuccessLast | Successfully connection, reached the valency target. Other ongoing connection attempts will be killed. |
| ConnectValencyExceeded | Someone else manged to create the final connection to a target before us. |
Instances
| Show ConnectResult Source # | |
Defined in Ouroboros.Network.Subscription.Worker | |
| Eq ConnectResult Source # | |
Defined in Ouroboros.Network.Subscription.Worker Methods (==) ∷ ConnectResult → ConnectResult → Bool Source # (/=) ∷ ConnectResult → ConnectResult → Bool Source # | |
| Ord ConnectResult Source # | |
Defined in Ouroboros.Network.Subscription.Worker Methods compare ∷ ConnectResult → ConnectResult → Ordering Source # (<) ∷ ConnectResult → ConnectResult → Bool Source # (<=) ∷ ConnectResult → ConnectResult → Bool Source # (>) ∷ ConnectResult → ConnectResult → Bool Source # (>=) ∷ ConnectResult → ConnectResult → Bool Source # max ∷ ConnectResult → ConnectResult → ConnectResult Source # min ∷ ConnectResult → ConnectResult → ConnectResult Source # | |
data Result addr r where Source #
Result of the connection thread. It's either result of an application, or an exception thrown by it.
Constructors
| ApplicationResult ∷ !Time → !addr → !r → Result addr r | |
| Connected ∷ !Time → !addr → Result addr r | |
| ConnectionError ∷ Exception e ⇒ !Time → !addr → !e → Result addr r | |
| ApplicationError ∷ Exception e ⇒ !Time → !addr → !e → Result addr r |
type Main m s t = s → STM m t Source #
Given current state retry too keep the subscription worker going.
When this transaction returns, all the threads spawned by the worker will be
killed.
type StateVar m s = StrictTVar m s Source #
Mutable state kept by the worker. All the workers in this module are polymorphic over the state type. The state is updated with two callbacks:
CompleteConnect- STM transaction which runs when the connect call returned, if it thrown an exception it will be passed to the callback.CompleteApplication- STM transaction which runs when application returned. It will receive the result of the application or an exception raised by it.
data LocalAddresses addr Source #
Constructors
| LocalAddresses | |
Instances
| Semigroup (LocalAddresses addr) Source # | |
Defined in Ouroboros.Network.Subscription.Worker Methods (<>) ∷ LocalAddresses addr → LocalAddresses addr → LocalAddresses addr Source # sconcat ∷ NonEmpty (LocalAddresses addr) → LocalAddresses addr Source # stimes ∷ Integral b ⇒ b → LocalAddresses addr → LocalAddresses addr Source # | |
| Show addr ⇒ Show (LocalAddresses addr) Source # | |
Defined in Ouroboros.Network.Subscription.Worker | |
| Eq addr ⇒ Eq (LocalAddresses addr) Source # | |
Defined in Ouroboros.Network.Subscription.Worker Methods (==) ∷ LocalAddresses addr → LocalAddresses addr → Bool Source # (/=) ∷ LocalAddresses addr → LocalAddresses addr → Bool Source # | |
Subscription worker
data WorkerCallbacks m s addr a t Source #
Worker STM callbacks
Constructors
| WorkerCallbacks | |
Fields
| |
data WorkerParams m localAddrs addr Source #
Worker parameters
Constructors
| WorkerParams | |
Fields
| |
Arguments
| ∷ ∀ s sock localAddrs addr a x. Ord addr | |
| ⇒ Tracer IO (SubscriptionTrace addr) | |
| → Tracer IO (WithAddr addr ErrorPolicyTrace) | |
| → ConnectionTable IO addr | |
| → StateVar IO s | |
| → Snocket IO sock addr | |
| → (sock → addr → IO ()) | |
| → WorkerCallbacks IO s addr a x | |
| → WorkerParams IO localAddrs addr | |
| → (sock → IO a) | application |
| → IO x |
This is the most abstract worker, which puts all the pieces together. It
will execute until main :: Main m s t returns. It runs
subscriptionLoop in a new threads and will exit when it dies. Spawn
threads are cancelled in a finally callback by throwing SubscriberError.
Note: This function runs in IO only because MonadSTM does not yet support
orElse, PR #432.
Socket API
Arguments
| ∷ MonadMask m | |
| ⇒ Snocket m sock addr | |
| → (sock → addr → m ()) | configure the socket |
| → addr | remote addr |
| → addr | local addr |
| → m () | allocate extra action; executed with async exceptions masked in
the allocation action of |
| → m () | release extra action; executed with async exceptions masked in
the closing action of |
| → ((∀ x. m x → m x) → sock → Either SomeException () → m t) | continuation executed with async exceptions masked; it receives: unmask function, allocated socket and connection error. |
| → m t |
Allocate a socket and connect to a peer, execute the continuation with
async exceptions masked. The continuation receives the unmask callback.
Constants
defaultConnectionAttemptDelay ∷ DiffTime Source #
Time to wait between connection attempts when we don't have any DeltaQ info.
minConnectionAttemptDelay ∷ DiffTime Source #
Minimum time to wait between connection attempts.
maxConnectionAttemptDelay ∷ DiffTime Source #
Maximum time to wait between connection attempts.
ipRetryDelay ∷ DiffTime Source #
Minimum time to wait between ip reconnects
Errors
data SubscriberError Source #
Constructors
| SubscriberError | |
Instances
Tracing
data SubscriptionTrace addr Source #
Constructors
Instances
| Show addr ⇒ Show (SubscriptionTrace addr) Source # | |
Defined in Ouroboros.Network.Subscription.Worker | |