ouroboros-network-framework-0.13.2.0: Ouroboros network framework
Safe HaskellSafe-Inferred
LanguageHaskell2010

Ouroboros.Network.Server2

Description

Server implementation based on ConnectionManager

Synopsis

Documentation

data ServerArguments (muxMode ∷ MuxMode) socket initiatorCtx peerAddr versionData versionNumber bytes m a b Source #

Server static configuration.

Constructors

ServerArguments 

Fields

data PublicInboundGovernorState peerAddr versionData Source #

Public inbound governor state.

Constructors

PublicInboundGovernorState 

Fields

Run server

with Source #

Arguments

∷ ∀ muxMode socket initiatorCtx peerAddr versionData versionNumber m a b x. (Alternative (STM m), MonadAsync m, MonadDelay m, MonadCatch m, MonadEvaluate m, MonadLabelledSTM m, MonadMask m, MonadThrow (STM m), MonadTime m, MonadTimer m, HasResponder muxMode ~ True, Ord peerAddr, Show peerAddr) 
ServerArguments muxMode socket initiatorCtx peerAddr versionData versionNumber ByteString m a b

record which holds all server arguments

→ (Async m Void → m (PublicInboundGovernorState peerAddr versionData) → m x)

a callback which receives a handle to inbound governor thread and can read PublicInboundGovernorState.

Note that as soon as the callback returns, all threads run by the server will be stopped.

→ m x 

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 ServerTrace peerAddr Source #

Constructors

TrAcceptConnection peerAddr 
TrAcceptError SomeException 
TrAcceptPolicyTrace AcceptConnectionsPolicyTrace 
TrServerStarted [peerAddr] 
TrServerStopped 
TrServerError SomeException

similar to TrAcceptConnection but it is logged once the connection is handed to inbound connection manager, e.g. after handshake negotiation.

Instances

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

Defined in Ouroboros.Network.Server2

Methods

showsPrecIntServerTrace peerAddr → ShowS #

showServerTrace peerAddr → String #

showList ∷ [ServerTrace peerAddr] → ShowS #

data AcceptConnectionsPolicyTrace Source #

Trace for the AcceptConnectionsLimit policy.

data RemoteSt Source #

Remote connection state tracked by inbound protocol governor.

This type is used for tracing.

Instances

Instances details
Show RemoteSt Source # 
Instance details

Defined in Ouroboros.Network.InboundGovernor.State

Methods

showsPrecIntRemoteStShowS #

showRemoteStString #

showList ∷ [RemoteSt] → ShowS #

Eq RemoteSt Source # 
Instance details

Defined in Ouroboros.Network.InboundGovernor.State

Methods

(==)RemoteStRemoteStBool #

(/=)RemoteStRemoteStBool #

type RemoteTransition = Transition' (Maybe RemoteSt) Source #

Nothing represents uninitialised state.