Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.ErrorPolicy

Contents

Traces
Re-exports of PeerState

Description

Error policies, and integration with SuspendDecision-semigroup action on PeerState.

Synopsis

data ErrorPolicies = ErrorPolicies {
- epAppErrorPolicies :: [ErrorPolicy]
- epConErrorPolicies :: [ErrorPolicy]
}
nullErrorPolicies :: ErrorPolicies
data ErrorPolicy where
- ErrorPolicy :: forall e. Exception e => (e -> Maybe (SuspendDecision DiffTime)) -> ErrorPolicy
evalErrorPolicy :: Exception e => e -> ErrorPolicy -> Maybe (SuspendDecision DiffTime)
evalErrorPolicies :: Exception e => e -> [ErrorPolicy] -> Maybe (SuspendDecision DiffTime)
type CompleteApplication (m :: Type -> Type) s addr r = Result addr r -> s -> STM m (CompleteApplicationResult m addr s)
data CompleteApplicationResult (m :: Type -> Type) addr s = CompleteApplicationResult {
- carState :: !s
- carThreads :: Set (Async m ())
- carTrace :: Maybe (WithAddr addr ErrorPolicyTrace)
}
data Result addr r where
- ApplicationResult :: forall addr r. !Time -> !addr -> !r -> Result addr r
- Connected :: forall addr r. !Time -> !addr -> Result addr r
- ConnectionError :: forall e addr r. Exception e => !Time -> !addr -> !e -> Result addr r
- ApplicationError :: forall e addr r. Exception e => !Time -> !addr -> !e -> Result addr r
completeApplicationTx :: forall (m :: Type -> Type) addr a. (MonadAsync m, Ord addr, Ord (Async m ())) => ErrorPolicies -> CompleteApplication m (PeerStates m addr) addr a
data ErrorPolicyTrace
- = ErrorPolicySuspendPeer (Maybe (ConnectionOrApplicationExceptionTrace SomeException)) DiffTime DiffTime
- | ErrorPolicySuspendConsumer (Maybe (ConnectionOrApplicationExceptionTrace SomeException)) DiffTime
- | ErrorPolicyLocalNodeError (ConnectionOrApplicationExceptionTrace SomeException)
- | ErrorPolicyResumePeer
- | ErrorPolicyKeepSuspended
- | ErrorPolicyResumeConsumer
- | ErrorPolicyResumeProducer
- | ErrorPolicyUnhandledApplicationException SomeException
- | ErrorPolicyUnhandledConnectionException SomeException
- | ErrorPolicyAcceptException IOException
traceErrorPolicy :: Either (ConnectionOrApplicationExceptionTrace SomeException) r -> SuspendDecision DiffTime -> Maybe ErrorPolicyTrace
data WithAddr addr a = WithAddr {
- wiaAddr :: addr
- wiaEvent :: a
}
data PeerStates (m :: Type -> Type) addr
data SuspendDecision t
- = SuspendPeer !t !t
- | SuspendConsumer !t
- | Throw

Documentation

data ErrorPolicies Source #

List of error policies for exception handling and a policy for handing application return values.

Constructors

ErrorPolicies
Fields epAppErrorPolicies :: [ErrorPolicy] Application Error Policies epConErrorPolicies :: [ErrorPolicy] `connect` Error Policies

Instances

Instances details

Semigroup ErrorPolicies Source #
Instance details Defined in Ouroboros.Network.ErrorPolicy Methods (<>) :: ErrorPolicies -> ErrorPolicies -> ErrorPolicies # sconcat :: NonEmpty ErrorPolicies -> ErrorPolicies # stimes :: Integral b => b -> ErrorPolicies -> ErrorPolicies #

nullErrorPolicies :: ErrorPolicies Source #

data ErrorPolicy where Source #

Constructors

ErrorPolicy
Fields :: forall e. Exception e => (e -> Maybe (SuspendDecision DiffTime)) `Nothing` means no decision. It is equivalent to not having the policy at all. In `evalErrorPolicies` this will fall-through and match against the remaining policies. -> ErrorPolicy

Instances

Instances details

Show ErrorPolicy Source #
Instance details Defined in Ouroboros.Network.ErrorPolicy Methods showsPrec :: Int -> ErrorPolicy -> ShowS # show :: ErrorPolicy -> String # showList :: [ErrorPolicy] -> ShowS #

evalErrorPolicy :: Exception e => e -> ErrorPolicy -> Maybe (SuspendDecision DiffTime) Source #

evalErrorPolicies :: Exception e => e -> [ErrorPolicy] -> Maybe (SuspendDecision DiffTime) Source #

Evaluate a list of ErrorPolicys; If none of them applies this function returns Nothing, in this case the exception will be traced and not thrown.

type CompleteApplication (m :: Type -> Type) s addr r = Result addr r -> s -> STM m (CompleteApplicationResult m addr s) Source #

Complete a connection, which receive application result (or exception).

data CompleteApplicationResult (m :: Type -> Type) addr s Source #

Constructors

CompleteApplicationResult
Fields carState :: !s new state carThreads :: Set (Async m ()) threads to kill carTrace :: Maybe (WithAddr addr ErrorPolicyTrace) trace points

Instances

Instances details

Functor (CompleteApplicationResult m addr) Source #
Instance details Defined in Ouroboros.Network.ErrorPolicy Methods fmap :: (a -> b) -> CompleteApplicationResult m addr a -> CompleteApplicationResult m addr b # (<$) :: a -> CompleteApplicationResult m addr b -> CompleteApplicationResult m addr a #

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 :: forall addr r. !Time -> !addr -> !r -> Result addr r
Connected :: forall addr r. !Time -> !addr -> Result addr r
ConnectionError :: forall e addr r. Exception e => !Time -> !addr -> !e -> Result addr r
ApplicationError :: forall e addr r. Exception e => !Time -> !addr -> !e -> Result addr r

completeApplicationTx :: forall (m :: Type -> Type) addr a. (MonadAsync m, Ord addr, Ord (Async m ())) => ErrorPolicies -> CompleteApplication m (PeerStates m addr) addr a Source #

CompleteApplication callback

Traces

data ErrorPolicyTrace Source #

Trace data for error policies

Constructors

ErrorPolicySuspendPeer (Maybe (ConnectionOrApplicationExceptionTrace SomeException)) DiffTime DiffTime	suspending peer with a given exception until
ErrorPolicySuspendConsumer (Maybe (ConnectionOrApplicationExceptionTrace SomeException)) DiffTime	suspending consumer until
ErrorPolicyLocalNodeError (ConnectionOrApplicationExceptionTrace SomeException)	caught a local exception
ErrorPolicyResumePeer	resume a peer (both consumer and producer)
ErrorPolicyKeepSuspended	consumer was suspended until producer will resume
ErrorPolicyResumeConsumer	resume consumer
ErrorPolicyResumeProducer	resume producer
ErrorPolicyUnhandledApplicationException SomeException	an application throwed an exception, which was not handled by any `ErrorPolicy`.
ErrorPolicyUnhandledConnectionException SomeException	`connect` throwed an exception, which was not handled by any `ErrorPolicy`.
ErrorPolicyAcceptException IOException	`accept` throwed an exception

Instances

Instances details

Show ErrorPolicyTrace Source #
Instance details Defined in Ouroboros.Network.ErrorPolicy Methods showsPrec :: Int -> ErrorPolicyTrace -> ShowS # show :: ErrorPolicyTrace -> String # showList :: [ErrorPolicyTrace] -> ShowS #

traceErrorPolicy :: Either (ConnectionOrApplicationExceptionTrace SomeException) r -> SuspendDecision DiffTime -> Maybe ErrorPolicyTrace Source #

data WithAddr addr a Source #

Constructors

WithAddr
Fields wiaAddr :: addr wiaEvent :: a

Instances

Instances details

(Show addr, Show a) => Show (WithAddr addr a) Source #
Instance details Defined in Ouroboros.Network.ErrorPolicy Methods showsPrec :: Int -> WithAddr addr a -> ShowS # show :: WithAddr addr a -> String # showList :: [WithAddr addr a] -> ShowS #

Re-exports of PeerState

data PeerStates (m :: Type -> Type) addr Source #

Map from addresses to PeerStates; it will be be shared in a StrictTVar.

Abstracting t is useful for tests, the IO version will use Time IO.

Instances

Instances details

Show addr => Show (PeerStates IO addr) Source #
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods showsPrec :: Int -> PeerStates IO addr -> ShowS # show :: PeerStates IO addr -> String # showList :: [PeerStates IO addr] -> ShowS #
Eq addr => Eq (PeerStates IO addr) Source #
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods (==) :: PeerStates IO addr -> PeerStates IO addr -> Bool # (/=) :: PeerStates IO addr -> PeerStates IO addr -> Bool #

data SuspendDecision t Source #

Semigroup of commands which acts on PeerState. The t variable might be initiated to DiffTime or Time m.

This semigroup allows to either suspend both consumer and producer or just the consumer part.

Constructors

SuspendPeer !t !t	peer is suspend; The first `t` is the time until which a local producer is suspended, the second one is the time until which a local consumer is suspended.
SuspendConsumer !t	suspend local consumer / initiator side until `t` (this mean we are not allowing to communicate with the producer / responder of a remote peer).
Throw	throw an error from the main thread.

Instances

Instances details

Functor SuspendDecision Source #
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods fmap :: (a -> b) -> SuspendDecision a -> SuspendDecision b # (<$) :: a -> SuspendDecision b -> SuspendDecision a #
Ord t => Semigroup (SuspendDecision t) Source #	The semigroup instance. Note that composing `SuspendPeer` with `SuspendConsumer` gives `SuspendPeer`. `SuspendPeer` and `SuspendConsumer` form a sub-semigroup.
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods (<>) :: SuspendDecision t -> SuspendDecision t -> SuspendDecision t # sconcat :: NonEmpty (SuspendDecision t) -> SuspendDecision t # stimes :: Integral b => b -> SuspendDecision t -> SuspendDecision t #
Show t => Show (SuspendDecision t) Source #
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods showsPrec :: Int -> SuspendDecision t -> ShowS # show :: SuspendDecision t -> String # showList :: [SuspendDecision t] -> ShowS #
Eq t => Eq (SuspendDecision t) Source #
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods (==) :: SuspendDecision t -> SuspendDecision t -> Bool # (/=) :: SuspendDecision t -> SuspendDecision t -> Bool #
Ord t => Ord (SuspendDecision t) Source #
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods compare :: SuspendDecision t -> SuspendDecision t -> Ordering # (<) :: SuspendDecision t -> SuspendDecision t -> Bool # (<=) :: SuspendDecision t -> SuspendDecision t -> Bool # (>) :: SuspendDecision t -> SuspendDecision t -> Bool # (>=) :: SuspendDecision t -> SuspendDecision t -> Bool # max :: SuspendDecision t -> SuspendDecision t -> SuspendDecision t # min :: SuspendDecision t -> SuspendDecision t -> SuspendDecision t #
SAct (SuspendDecision Time) (Maybe (PeerState m)) Source #	Action of `SuspendDecision` on `Maybe PeerState`. We use this action together with `alter` function. Note: `SuspendDecision` does not act on `PeerState`, only the sub-semigroup generated by `SuspendConsumer` and `SuspendPeer` does.
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods (<\|) :: Maybe (PeerState m) -> SuspendDecision Time -> Maybe (PeerState m) #