Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Server2

Contents

Run server
Trace
ControlChannel

Description

Server implementation based on ConnectionManager

Synopsis

data ServerArguments (muxMode :: MuxMode ) socket peerAddr 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)
- serverConnectionLimits :: AcceptedConnectionsLimit
- serverConnectionManager :: MuxConnectionManager muxMode socket peerAddr versionNumber bytes m a b
- serverInboundIdleTimeout :: DiffTime
- serverControlChannel :: ServerControlChannel muxMode peerAddr bytes m a b
- serverObservableStateVar :: StrictTVar m InboundGovernorObservableState
}
newtype InboundGovernorObservableState = InboundGovernorObservableState {
- igosPrng :: StdGen
}
newObservableStateVar :: MonadLabelledSTM m => StdGen -> m ( StrictTVar m InboundGovernorObservableState )
newObservableStateVarIO :: IO ( StrictTVar IO InboundGovernorObservableState )
newObservableStateVarFromSeed :: MonadLabelledSTM m => Int -> m ( StrictTVar m InboundGovernorObservableState )
run :: forall muxMode socket peerAddr versionNumber m a b. ( MonadAsync 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 peerAddr versionNumber ByteString m a b -> m Void
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 )
module Ouroboros.Network.InboundGovernor.ControlChannel

Documentation

data ServerArguments (muxMode :: MuxMode ) socket peerAddr 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)
serverConnectionLimits :: AcceptedConnectionsLimit
serverConnectionManager :: MuxConnectionManager muxMode socket peerAddr versionNumber bytes m a b
serverInboundIdleTimeout :: DiffTime

Time for which all protocols need to be idle to trigger DemotedToCold transition.
serverControlChannel :: ServerControlChannel muxMode peerAddr 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.
serverObservableStateVar :: StrictTVar m InboundGovernorObservableState

Observable mutable state.

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 igosPrng :: StdGen

newObservableStateVar :: MonadLabelledSTM m => StdGen -> m ( StrictTVar m InboundGovernorObservableState ) Source #

Create new observable state StrictTVar .

newObservableStateVarIO :: IO ( 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 server

run :: forall muxMode socket peerAddr versionNumber m a b. ( MonadAsync 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 peerAddr versionNumber ByteString m a b -> 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 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 Source # show :: ServerTrace peerAddr -> String Source # showList :: [ ServerTrace peerAddr] -> ShowS Source #

data AcceptConnectionsPolicyTrace Source #

Trace for the AcceptConnectionsLimit policy.

Constructors

ServerTraceAcceptConnectionRateLimiting DiffTime Int
ServerTraceAcceptConnectionHardLimit Word32
ServerTraceAcceptConnectionResume Int

Instances

Instances details

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

data RemoteSt Source #

Remote connection state tracked by inbound protocol governor.

Constructors

RemoteWarmSt
RemoteHotSt
RemoteIdleSt
RemoteColdSt

Instances

Instances details

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

type RemoteTransition = Transition' ( Maybe RemoteSt ) Source #

Nothing represents unitialised state.

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

ControlChannel

module Ouroboros.Network.InboundGovernor.ControlChannel