Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Server2

Contents

Run server
Trace

Description

Server implementation based on ConnectionManager

This module should be imported qualified.

Synopsis

data Arguments (muxMode :: Mode) socket initiatorCtx peerAddr versionData versionNumber bytes (m :: Type -> Type) a b = Arguments {
- sockets :: NonEmpty socket
- snocket :: Snocket m socket peerAddr
- tracer :: Tracer m (Trace peerAddr)
- trTracer :: Tracer m (RemoteTransitionTrace peerAddr)
- inboundGovernorTracer :: Tracer m (Trace peerAddr)
- debugInboundGovernor :: Tracer m (Debug peerAddr versionData)
- connectionLimits :: AcceptedConnectionsLimit
- connectionManager :: MuxConnectionManager muxMode socket initiatorCtx (ResponderContext peerAddr) peerAddr versionData versionNumber bytes m a b
- inboundIdleTimeout :: Maybe DiffTime
- connectionDataFlow :: versionData -> DataFlow
- inboundInfoChannel :: InboundGovernorInfoChannel muxMode initiatorCtx peerAddr versionData bytes m a b
}
with :: forall (muxMode :: Mode) 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) => Arguments muxMode socket initiatorCtx peerAddr versionData versionNumber ByteString m a b -> (Async m Void -> m (PublicState peerAddr versionData) -> m x) -> m x
data Trace peerAddr
- = TrAcceptConnection (ConnectionId 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)
isECONNABORTED :: IOError -> Bool

Documentation

data Arguments (muxMode :: Mode) socket initiatorCtx peerAddr versionData versionNumber bytes (m :: Type -> Type) a b Source #

Server static configuration.

Constructors

Arguments

Fields

sockets :: NonEmpty socket
snocket :: Snocket m socket peerAddr
tracer :: Tracer m (Trace peerAddr)
trTracer :: Tracer m (RemoteTransitionTrace peerAddr)
inboundGovernorTracer :: Tracer m (Trace peerAddr)
debugInboundGovernor :: Tracer m (Debug peerAddr versionData)
connectionLimits :: AcceptedConnectionsLimit
connectionManager :: MuxConnectionManager muxMode socket initiatorCtx (ResponderContext peerAddr) peerAddr versionData versionNumber bytes m a b
inboundIdleTimeout :: Maybe DiffTime
Time for which all protocols need to be idle to trigger DemotedToCold transition.
connectionDataFlow :: versionData -> DataFlow
inboundInfoChannel :: 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.

Run server

with Source #

Arguments

:: forall (muxMode :: Mode) 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)
=> Arguments muxMode socket initiatorCtx peerAddr versionData versionNumber ByteString m a b	record which holds all server arguments
-> (Async m Void -> m (PublicState peerAddr versionData) -> m x)	a callback which receives a handle to inbound governor thread and can read `PublicState`. 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:

InitiatorResponderMode
ResponderMode

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

Constructors

TrAcceptConnection (ConnectionId 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 (Trace peerAddr) Source #
Instance details Defined in Ouroboros.Network.Server2 Methods showsPrec :: Int -> Trace peerAddr -> ShowS # show :: Trace peerAddr -> String # showList :: [Trace 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 #

isECONNABORTED :: IOError -> Bool Source #