ouroboros-network-framework-0.1.0.0
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Network.InboundGovernor

Description

Server implementation based on ConnectionManager

Synopsis

Documentation

newtype InboundGovernorObservableState Source #

Currently only StdGen, but in the future this will be extended to a record which contains some useful statistics about peers to support more advances prune strategies (see. PruneStrategy).

Constructors

InboundGovernorObservableState 

Fields

newObservableStateVar ∷ MonadLabelledSTM m ⇒ StdGen → m (StrictTVar m InboundGovernorObservableState) Source #

Create new observable state StrictTVar.

newObservableStateVarIOIO (StrictTVar IO InboundGovernorObservableState) Source #

Using the global StdGen.

newObservableStateVarFromSeed ∷ MonadLabelledSTM m ⇒ Int → m (StrictTVar m InboundGovernorObservableState) Source #

Useful for testing, it is using mkStdGen.

Run Inbound Protocol Governor

inboundGovernor ∷ ∀ (muxMode ∷ MuxMode) socket peerAddr versionNumber m a b. (MonadAsync m, MonadCatch m, MonadEvaluate m, MonadThrow m, MonadThrow (STM m), MonadTime m, MonadTimer m, MonadMask m, Ord peerAddr, HasResponder muxMode ~ True) ⇒ Tracer m (RemoteTransitionTrace peerAddr) → Tracer m (InboundGovernorTrace peerAddr) → ServerControlChannel muxMode peerAddr ByteString m a b → DiffTimeMuxConnectionManager muxMode socket peerAddr versionNumber ByteString m a b → StrictTVar m InboundGovernorObservableState → m Void Source #

Run the server, which consists of the following components:

  • inbound governor, it corresponds to p2p-governor on outbound side
  • accept loop(s), one per given ip address. We support up to one ipv4 address and up to one ipv6 address, i.e. an ipv6 enabled node will run two accept loops on listening on different addresses with shared inbound governor.

The server can be run in either of two MuxMode-es:

The first one is used in data diffusion for Node-To-Node protocol, while the other is useful for running a server for the Node-To-Client protocol.

Trace

data InboundGovernorTrace peerAddr Source #

Instances

Instances details
Show peerAddr ⇒ Show (InboundGovernorTrace peerAddr) Source # 
Instance details

Defined in Ouroboros.Network.InboundGovernor

data RemoteSt Source #

Remote connection state tracked by inbound protocol governor.

Instances

Instances details
Eq RemoteSt Source # 
Instance details

Defined in Ouroboros.Network.InboundGovernor

Show RemoteSt Source # 
Instance details

Defined in Ouroboros.Network.InboundGovernor

type RemoteTransition = Transition' (Maybe RemoteSt) Source #

Nothing represents unitialised state.

data AcceptConnectionsPolicyTrace Source #

Trace for the AcceptConnectionsLimit policy.

Re-exports

data Transition' state Source #

Constructors

Transition 

Fields

Instances

Instances details
Functor Transition' Source # 
Instance details

Defined in Ouroboros.Network.ConnectionManager.Types

Methods

fmap ∷ (a → b) → Transition' a → Transition' b Source #

(<$) ∷ a → Transition' b → Transition' a Source #

Eq state ⇒ Eq (Transition' state) Source # 
Instance details

Defined in Ouroboros.Network.ConnectionManager.Types

Methods

(==)Transition' state → Transition' state → Bool Source #

(/=)Transition' state → Transition' state → Bool Source #

Show state ⇒ Show (Transition' state) Source # 
Instance details

Defined in Ouroboros.Network.ConnectionManager.Types

Methods

showsPrecIntTransition' state → ShowS Source #

showTransition' state → String Source #

showList ∷ [Transition' state] → ShowS Source #

data TransitionTrace' peerAddr state Source #

Constructors

TransitionTrace 

Fields

Instances

Instances details
Functor (TransitionTrace' peerAddr) Source # 
Instance details

Defined in Ouroboros.Network.ConnectionManager.Types

Methods

fmap ∷ (a → b) → TransitionTrace' peerAddr a → TransitionTrace' peerAddr b Source #

(<$) ∷ a → TransitionTrace' peerAddr b → TransitionTrace' peerAddr a Source #

(Show peerAddr, Show state) ⇒ Show (TransitionTrace' peerAddr state) Source # 
Instance details

Defined in Ouroboros.Network.ConnectionManager.Types

Methods

showsPrecIntTransitionTrace' peerAddr state → ShowS Source #

showTransitionTrace' peerAddr state → String Source #

showList ∷ [TransitionTrace' peerAddr state] → ShowS Source #