Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.Server2

Contents

Run server
Trace

Description

Server implementation based on ConnectionManager

Synopsis

data ServerArguments (muxMode ∷ MuxMode) socket initiatorCtx peerAddr versionData versionNumber bytes m a b = ServerArguments {
- serverSockets ∷ NonEmpty socket
- serverSnocket ∷ Snocket m socket peerAddr
- serverTracer ∷ Tracer m (ServerTrace peerAddr)
- serverTrTracer ∷ Tracer m (RemoteTransitionTrace peerAddr)
- serverInboundGovernorTracer ∷ Tracer m (InboundGovernorTrace peerAddr)
- serverDebugInboundGovernor ∷ Tracer m (DebugInboundGovernor peerAddr)
- serverConnectionLimits ∷ AcceptedConnectionsLimit
- serverConnectionManager ∷ MuxConnectionManager muxMode socket initiatorCtx (ResponderContext peerAddr) peerAddr versionData versionNumber bytes m a b
- serverInboundIdleTimeout ∷ Maybe DiffTime
- serverInboundInfoChannel ∷ InboundGovernorInfoChannel muxMode initiatorCtx peerAddr versionData bytes m a b
}
data PublicInboundGovernorState peerAddr versionData = PublicInboundGovernorState {
- inboundDuplexPeers ∷ !(Map peerAddr versionData)
- remoteStateMap ∷ Map (ConnectionId peerAddr) RemoteSt
}
with ∷ ∀ 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 → (Async m Void → m (PublicInboundGovernorState peerAddr versionData) → m x) → m x
data ServerTrace peerAddr
- = TrAcceptConnection peerAddr
- | TrAcceptError SomeException
- | TrAcceptPolicyTrace AcceptConnectionsPolicyTrace
- | TrServerStarted [peerAddr]
- | TrServerStopped
- | TrServerError SomeException
data AcceptConnectionsPolicyTrace
data RemoteSt
- = RemoteWarmSt
- | RemoteHotSt
- | RemoteIdleSt
- | RemoteColdSt
type RemoteTransition = Transition' (Maybe RemoteSt)
type RemoteTransitionTrace peerAddr = TransitionTrace' peerAddr (Maybe RemoteSt)

Documentation

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

Server static configuration.

Constructors

ServerArguments

Fields

serverSockets ∷ NonEmpty socket
serverSnocket ∷ Snocket m socket peerAddr
serverTracer ∷ Tracer m (ServerTrace peerAddr)
serverTrTracer ∷ Tracer m (RemoteTransitionTrace peerAddr)
serverInboundGovernorTracer ∷ Tracer m (InboundGovernorTrace peerAddr)
serverDebugInboundGovernor ∷ Tracer m (DebugInboundGovernor peerAddr)
serverConnectionLimits ∷ AcceptedConnectionsLimit
serverConnectionManager ∷ MuxConnectionManager muxMode socket initiatorCtx (ResponderContext peerAddr) peerAddr versionData versionNumber bytes m a b
serverInboundIdleTimeout ∷ Maybe DiffTime
Time for which all protocols need to be idle to trigger DemotedToCold transition.
serverInboundInfoChannel ∷ InboundGovernorInfoChannel muxMode initiatorCtx peerAddr versionData bytes m a b
Server control var is passed as an argument; this allows to use the server to run and manage responders which needs to be started on inbound connections.

data PublicInboundGovernorState peerAddr versionData Source #

Public inbound governor state.

Constructors

PublicInboundGovernorState
Fields inboundDuplexPeers ∷ !(Map peerAddr versionData) A map of mature inbound duplex connections. These peers are used for light peer sharing (e.g. bootstrapping peer sharing). remoteStateMap ∷ Map (ConnectionId peerAddr) RemoteSt Map of `RemoteSt`. It is lazy on purpose. It is created from `igsConnections`, so it should not point to any thunks that should be GC-ed leading to a memory leak.

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 showsPrec ∷ Int → ServerTrace peerAddr → ShowS # show ∷ ServerTrace peerAddr → String # showList ∷ [ServerTrace peerAddr] → ShowS #

data AcceptConnectionsPolicyTrace Source #

Trace for the AcceptConnectionsLimit policy.

Constructors

ServerTraceAcceptConnectionRateLimiting DiffTime Int
ServerTraceAcceptConnectionHardLimit Word32
ServerTraceAcceptConnectionResume Int

Instances

Instances details

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

data RemoteSt Source #

Remote connection state tracked by inbound protocol governor.

This type is used for tracing.

Constructors

RemoteWarmSt
RemoteHotSt
RemoteIdleSt
RemoteColdSt

Instances

Instances details

Show RemoteSt Source #
Instance details Defined in Ouroboros.Network.InboundGovernor.State Methods showsPrec ∷ Int → RemoteSt → ShowS # show ∷ RemoteSt → String # showList ∷ [RemoteSt] → ShowS #
Eq RemoteSt Source #
Instance details Defined in Ouroboros.Network.InboundGovernor.State Methods (==) ∷ RemoteSt → RemoteSt → Bool # (/=) ∷ RemoteSt → RemoteSt → Bool #

type RemoteTransition = Transition' (Maybe RemoteSt) Source #

Nothing represents uninitialised state.

type RemoteTransitionTrace peerAddr = TransitionTrace' peerAddr (Maybe RemoteSt) Source #