Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.Subscription.Worker

Contents

Subscription worker
Socket API
Constants
Errors
Tracing

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 {
- laIpv4 ∷ Maybe addr
- laIpv6 ∷ Maybe addr
- laUnix ∷ Maybe addr
}
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 {
- seType ∷ !SubscriberErrorType
- seMessage ∷ !String
- seStack ∷ !CallStack
}
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

Instances details

Show ConnectResult Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods showsPrec ∷ Int → ConnectResult → ShowS # show ∷ ConnectResult → String # showList ∷ [ConnectResult] → ShowS #
Eq ConnectResult Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods (==) ∷ ConnectResult → ConnectResult → Bool # (/=) ∷ ConnectResult → ConnectResult → Bool #
Ord ConnectResult Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods compare ∷ ConnectResult → ConnectResult → Ordering # (<) ∷ ConnectResult → ConnectResult → Bool # (<=) ∷ ConnectResult → ConnectResult → Bool # (>) ∷ ConnectResult → ConnectResult → Bool # (>=) ∷ ConnectResult → ConnectResult → Bool # max ∷ ConnectResult → ConnectResult → ConnectResult # min ∷ ConnectResult → ConnectResult → ConnectResult #

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
Fields laIpv4 ∷ Maybe addr Local IPv4 address to use, Nothing indicates don't use IPv4 laIpv6 ∷ Maybe addr Local IPv6 address to use, Nothing indicates don't use IPv6 laUnix ∷ Maybe addr Local Unix address to use, Nothing indicates don't use Unix sockets

Instances

Instances details

Semigroup (LocalAddresses addr) Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods (<>) ∷ LocalAddresses addr → LocalAddresses addr → LocalAddresses addr # sconcat ∷ NonEmpty (LocalAddresses addr) → LocalAddresses addr # stimes ∷ Integral b ⇒ b → LocalAddresses addr → LocalAddresses addr #
Show addr ⇒ Show (LocalAddresses addr) Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods showsPrec ∷ Int → LocalAddresses addr → ShowS # show ∷ LocalAddresses addr → String # showList ∷ [LocalAddresses addr] → ShowS #
Eq addr ⇒ Eq (LocalAddresses addr) Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods (==) ∷ LocalAddresses addr → LocalAddresses addr → Bool # (/=) ∷ LocalAddresses addr → LocalAddresses addr → Bool #

Subscription worker

data WorkerCallbacks m s addr a t Source #

Worker STM callbacks

Constructors

WorkerCallbacks
Fields wcSocketStateChangeTx ∷ SocketStateChange m s addr wcCompleteApplicationTx ∷ CompleteApplication m s addr a wcMainTx ∷ Main m s t

data WorkerParams m localAddrs addr Source #

Worker parameters

Constructors

WorkerParams
Fields wpLocalAddresses ∷ localAddrs addr local addresses of the server wpSelectAddress ∷ addr → localAddrs addr → Maybe addr given remote addr pick the local address wpConnectionAttemptDelay ∷ addr → Maybe DiffTime delay after a connection attempt to `addr` wpSubscriptionTarget ∷ m (SubscriptionTarget m addr) wpValency ∷ Int

worker Source #

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

safeConnect Source #

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 `bracket`
→ m ()	release extra action; executed with async exceptions masked in the closing action of `bracket`
→ ((∀ 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
Fields seType ∷ !SubscriberErrorType seMessage ∷ !String seStack ∷ !CallStack

Instances

Instances details

Exception SubscriberError Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods toException ∷ SubscriberError → SomeException # fromException ∷ SomeException → Maybe SubscriberError # displayException ∷ SubscriberError → String #
Show SubscriberError Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods showsPrec ∷ Int → SubscriberError → ShowS # show ∷ SubscriberError → String # showList ∷ [SubscriberError] → ShowS #

Tracing

data SubscriptionTrace addr Source #

Instances

Instances details

Show addr ⇒ Show (SubscriptionTrace addr) Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods showsPrec ∷ Int → SubscriptionTrace addr → ShowS # show ∷ SubscriptionTrace addr → String # showList ∷ [SubscriptionTrace addr] → ShowS #

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