Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.ConnectionManager.Core

Description

The implementation of connection manager.

Synopsis

data ConnectionManagerArguments handlerTrace socket peerAddr handle handleError versionNumber versionData m = ConnectionManagerArguments {
- cmTracer ∷ Tracer m (ConnectionManagerTrace peerAddr handlerTrace)
- cmTrTracer ∷ Tracer m (TransitionTrace peerAddr (ConnectionState peerAddr handle handleError versionNumber m))
- cmMuxTracer ∷ Tracer m (WithMuxBearer (ConnectionId peerAddr) MuxTrace)
- cmIPv4Address ∷ Maybe peerAddr
- cmIPv6Address ∷ Maybe peerAddr
- cmAddressType ∷ peerAddr → Maybe AddressType
- cmSnocket ∷ Snocket m socket peerAddr
- cmMakeBearer ∷ MakeBearer m socket
- cmConfigureSocket ∷ socket → Maybe peerAddr → m ()
- cmTimeWaitTimeout ∷ DiffTime
- cmOutboundIdleTimeout ∷ DiffTime
- connectionDataFlow ∷ versionNumber → versionData → DataFlow
- cmPrunePolicy ∷ PrunePolicy peerAddr (STM m)
- cmConnectionsLimits ∷ AcceptedConnectionsLimit
}
withConnectionManager ∷ ∀ (muxMode ∷ MuxMode) peerAddr socket handlerTrace handle handleError version versionData m a. (Alternative (STM m), MonadLabelledSTM m, MonadTraceSTM m, MonadFork m, MonadAsync m, MonadDelay m, MonadEvaluate m, MonadFix m, MonadMask m, MonadThrow (STM m), MonadTimer m, Ord peerAddr, Show peerAddr, Typeable peerAddr) ⇒ ConnectionManagerArguments handlerTrace socket peerAddr handle handleError version versionData m → ConnectionHandler muxMode handlerTrace socket peerAddr handle handleError (version, versionData) m → (handleError → HandleErrorType) → InResponderMode muxMode (ControlChannel peerAddr handle m) → (ConnectionManager muxMode socket peerAddr handle handleError m → m a) → m a
defaultTimeWaitTimeout ∷ DiffTime
defaultProtocolIdleTimeout ∷ DiffTime
defaultResetTimeout ∷ DiffTime
data ConnectionState peerAddr handle handleError version m
- = ReservedOutboundState
- | UnnegotiatedState !Provenance !(ConnectionId peerAddr) (Async m ())
- | OutboundUniState !(ConnectionId peerAddr) !(Async m ()) !handle
- | OutboundDupState !(ConnectionId peerAddr) !(Async m ()) !handle !TimeoutExpired
- | OutboundIdleState !(ConnectionId peerAddr) !(Async m ()) !handle !DataFlow
- | InboundIdleState !(ConnectionId peerAddr) !(Async m ()) !handle !DataFlow
- | InboundState !(ConnectionId peerAddr) !(Async m ()) !handle !DataFlow
- | DuplexState !(ConnectionId peerAddr) !(Async m ()) !handle
- | TerminatingState !(ConnectionId peerAddr) !(Async m ()) !(Maybe handleError)
- | TerminatedState !(Maybe handleError)
abstractState ∷ MaybeUnknown (ConnectionState muxMode peerAddr m a b) → AbstractState

Documentation

data ConnectionManagerArguments handlerTrace socket peerAddr handle handleError versionNumber versionData m Source #

Arguments for a ConnectionManager which are independent of MuxMode.

Constructors

ConnectionManagerArguments

Fields

cmTracer ∷ Tracer m (ConnectionManagerTrace peerAddr handlerTrace)
Connection manager tracer.
cmTrTracer ∷ Tracer m (TransitionTrace peerAddr (ConnectionState peerAddr handle handleError versionNumber m))
Trace state transitions.
cmMuxTracer ∷ Tracer m (WithMuxBearer (ConnectionId peerAddr) MuxTrace)
Mux trace.
cmIPv4Address ∷ Maybe peerAddr
IPv4 address of the connection manager. If given, outbound connections to an IPv4 address will bound to it. To use bidirectional TCP connections, it must be the same as the server listening IPv4 address.
cmIPv6Address ∷ Maybe peerAddr
IPv6 address of the connection manager. If given, outbound connections to an IPv6 address will bound to it. To use bidirectional TCP connections, it must be the same as the server listening IPv6 address.
cmAddressType ∷ peerAddr → Maybe AddressType
cmSnocket ∷ Snocket m socket peerAddr
Snocket for the socket type.
cmMakeBearer ∷ MakeBearer m socket
Make MuxBearer.
cmConfigureSocket ∷ socket → Maybe peerAddr → m ()
Socket configuration.
cmTimeWaitTimeout ∷ DiffTime
TCP will held connections in TIME_WAIT state for up to two MSL (maximum segment time). On Linux this is set to '60' seconds on other system this might be up to four minutes.
This is configurable, so we can set different value in tests.
When this timeout expires a connection will transition from TerminatingState to TerminatedState.
cmOutboundIdleTimeout ∷ DiffTime
Inactivity timeout before the connection will be reset. It is the timeout attached to the OutboundIdleState.
connectionDataFlow ∷ versionNumber → versionData → DataFlow
Given a version number and respective version data, get the DataFlow.
cmPrunePolicy ∷ PrunePolicy peerAddr (STM m)
Prune policy
cmConnectionsLimits ∷ AcceptedConnectionsLimit

withConnectionManager Source #

Arguments

∷ ∀ (muxMode ∷ MuxMode) peerAddr socket handlerTrace handle handleError version versionData m a. (Alternative (STM m), MonadLabelledSTM m, MonadTraceSTM m, MonadFork m, MonadAsync m, MonadDelay m, MonadEvaluate m, MonadFix m, MonadMask m, MonadThrow (STM m), MonadTimer m, Ord peerAddr, Show peerAddr, Typeable peerAddr)
⇒ ConnectionManagerArguments handlerTrace socket peerAddr handle handleError version versionData m
→ ConnectionHandler muxMode handlerTrace socket peerAddr handle handleError (version, versionData) m	Callback which runs in a thread dedicated for a given connection.
→ (handleError → HandleErrorType)	classify `handleError`s
→ InResponderMode muxMode (ControlChannel peerAddr handle m)	On outbound duplex connections we need to notify the server about a new connection.
→ (ConnectionManager muxMode socket peerAddr handle handleError m → m a)	Continuation which receives the `ConnectionManager`. It must not leak outside of scope of this callback. Once it returns all resources will be closed.
→ m a

Entry point for using the connection manager. This is a classic with style combinator, which cleans resources on exit of the callback (whether cleanly or through an exception).

Including a connection (either inbound or outbound) is an idempotent operation on connection manager state. The connection manager will always return the handle that was first to be included in its state.

Once an inbound connection is passed to the ConnectionManager, the manager is responsible for the resource.

defaultTimeWaitTimeout ∷ DiffTime Source #

The default value for cmTimeWaitTimeout.

defaultProtocolIdleTimeout ∷ DiffTime Source #

Inactivity timeout. It configures how long to wait since the local side demoted remote peer to cold, before closing the connection.

defaultResetTimeout ∷ DiffTime Source #

data ConnectionState peerAddr handle handleError version m Source #

State of a connection.

Constructors

ReservedOutboundState	Each outbound connections starts in this state.
UnnegotiatedState !Provenance !(ConnectionId peerAddr) (Async m ())	Each inbound connection starts in this state, outbound connection reach this state once `connect` call returns. note: the async handle is lazy, because it's passed with `mfix`.
OutboundUniState !(ConnectionId peerAddr) !(Async m ()) !handle	`OutboundState Unidirectional` state.
OutboundDupState !(ConnectionId peerAddr) !(Async m ()) !handle !TimeoutExpired	Either `OutboundState Duplex` or `OutobundState^tau Duplex`.
OutboundIdleState !(ConnectionId peerAddr) !(Async m ()) !handle !DataFlow	Before connection is reset it is put in `OutboundIdleState` for the duration of `cmOutboundIdleTimeout`.
InboundIdleState !(ConnectionId peerAddr) !(Async m ()) !handle !DataFlow
InboundState !(ConnectionId peerAddr) !(Async m ()) !handle !DataFlow
DuplexState !(ConnectionId peerAddr) !(Async m ()) !handle
TerminatingState !(ConnectionId peerAddr) !(Async m ()) !(Maybe handleError)
TerminatedState !(Maybe handleError)

Instances

Instances details

(Show peerAddr, Show handleError, MonadAsync m) ⇒ Show (ConnectionState peerAddr handle handleError version m) Source #
Instance details Defined in Ouroboros.Network.ConnectionManager.Core Methods showsPrec ∷ Int → ConnectionState peerAddr handle handleError version m → ShowS Source # show ∷ ConnectionState peerAddr handle handleError version m → String Source # showList ∷ [ConnectionState peerAddr handle handleError version m] → ShowS Source #

abstractState ∷ MaybeUnknown (ConnectionState muxMode peerAddr m a b) → AbstractState Source #