Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Diffusion

Contents

Common API
Run data diffusion
Re-exports

Synopsis

data P2P
- = P2P
- | NonP2P
data InitializationTracer ntnAddr ntcAddr
- = RunServer (NonEmpty ntnAddr)
- | RunLocalServer ntcAddr
- | UsingSystemdSocket ntcAddr
- | CreateSystemdSocketForSnocketPath ntcAddr
- | CreatedLocalSocket ntcAddr
- | ConfiguringLocalSocket ntcAddr FileDescriptor
- | ListeningLocalSocket ntcAddr FileDescriptor
- | LocalSocketUp ntcAddr FileDescriptor
- | CreatingServerSocket ntnAddr
- | ConfiguringServerSocket ntnAddr
- | ListeningServerSocket ntnAddr
- | ServerSocketUp ntnAddr
- | UnsupportedLocalSystemdSocket ntnAddr
- | UnsupportedReadySocketCase
- | DiffusionErrored SomeException
data Tracers ntnAddr ntnVersion ntcAddr ntcVersion m = Tracers {
- dtMuxTracer ∷ Tracer m (WithMuxBearer (ConnectionId ntnAddr) MuxTrace)
- dtHandshakeTracer ∷ Tracer m (HandshakeTr ntnAddr ntnVersion)
- dtLocalMuxTracer ∷ Tracer m (WithMuxBearer (ConnectionId ntcAddr) MuxTrace)
- dtLocalHandshakeTracer ∷ Tracer m (HandshakeTr ntcAddr ntcVersion)
- dtDiffusionInitializationTracer ∷ Tracer m (InitializationTracer ntnAddr ntcAddr)
- dtLedgerPeersTracer ∷ Tracer m TraceLedgerPeers
}
nullTracers ∷ Applicative m ⇒ Tracers ntnAddr ntnVersion ntcAddr ntcVersion m
data ExtraTracers (p2p ∷ P2P) where
- P2PTracers ∷ TracersExtra RemoteAddress NodeToNodeVersion NodeToNodeVersionData LocalAddress NodeToClientVersion NodeToClientVersionData IOException IO → ExtraTracers 'P2P
- NonP2PTracers ∷ TracersExtra → ExtraTracers 'NonP2P
data Failure ntnAddr
data Arguments ntnFd ntnAddr ntcFd ntcAddr = Arguments {
- daIPv4Address ∷ Maybe (Either ntnFd ntnAddr)
- daIPv6Address ∷ Maybe (Either ntnFd ntnAddr)
- daLocalAddress ∷ Maybe (Either ntcFd ntcAddr)
- daAcceptedConnectionsLimit ∷ AcceptedConnectionsLimit
- daMode ∷ DiffusionMode
}
data ExtraArguments (p2p ∷ P2P) m where
- P2PArguments ∷ ArgumentsExtra m → ExtraArguments 'P2P m
- NonP2PArguments ∷ ArgumentsExtra → ExtraArguments 'NonP2P m
data Applications ntnAddr ntnVersion ntnVersionData ntcAddr ntcVersion ntcVersionData m = Applications {
- daApplicationInitiatorMode ∷ Versions ntnVersion ntnVersionData (OuroborosBundle InitiatorMode ntnAddr ByteString m () Void)
- daApplicationInitiatorResponderMode ∷ Versions ntnVersion ntnVersionData (OuroborosBundle InitiatorResponderMode ntnAddr ByteString m () ())
- daLocalResponderApplication ∷ Versions ntcVersion ntcVersionData (OuroborosApplication ResponderMode ntcAddr ByteString m Void ())
- daLedgerPeersCtx ∷ LedgerPeersConsensusInterface m
}
data ExtraApplications (p2p ∷ P2P) ntnAddr m where
- P2PApplications ∷ ApplicationsExtra ntnAddr m → ExtraApplications 'P2P ntnAddr m
- NonP2PApplications ∷ ApplicationsExtra → ExtraApplications 'NonP2P ntnAddr m
run ∷ ∀ (p2p ∷ P2P). Tracers RemoteAddress NodeToNodeVersion LocalAddress NodeToClientVersion IO → ExtraTracers p2p → Arguments Socket RemoteAddress LocalSocket LocalAddress → ExtraArguments p2p IO → Applications RemoteAddress NodeToNodeVersion NodeToNodeVersionData LocalAddress NodeToClientVersion NodeToClientVersionData IO → ExtraApplications p2p RemoteAddress IO → IO ()
type AbstractTransitionTrace peerAddr = TransitionTrace' peerAddr AbstractState

Common API

data P2P Source #

Promoted data types.

Constructors

P2P
NonP2P

data InitializationTracer ntnAddr ntcAddr Source #

Constructors

RunServer (NonEmpty ntnAddr)
RunLocalServer ntcAddr
UsingSystemdSocket ntcAddr
CreateSystemdSocketForSnocketPath ntcAddr
CreatedLocalSocket ntcAddr
ConfiguringLocalSocket ntcAddr FileDescriptor
ListeningLocalSocket ntcAddr FileDescriptor
LocalSocketUp ntcAddr FileDescriptor
CreatingServerSocket ntnAddr
ConfiguringServerSocket ntnAddr
ListeningServerSocket ntnAddr
ServerSocketUp ntnAddr
UnsupportedLocalSystemdSocket ntnAddr
UnsupportedReadySocketCase
DiffusionErrored SomeException

Instances

Instances details

(Show ntnAddr, Show ntcAddr) ⇒ Show (InitializationTracer ntnAddr ntcAddr) Source #
Instance details Defined in Ouroboros.Network.Diffusion.Common Methods showsPrec ∷ Int → InitializationTracer ntnAddr ntcAddr → ShowS Source # show ∷ InitializationTracer ntnAddr ntcAddr → String Source # showList ∷ [InitializationTracer ntnAddr ntcAddr] → ShowS Source #

data Tracers ntnAddr ntnVersion ntcAddr ntcVersion m Source #

Common DiffusionTracers interface between P2P and NonP2P

Constructors

Tracers

Fields

dtMuxTracer ∷ Tracer m (WithMuxBearer (ConnectionId ntnAddr) MuxTrace)
Mux tracer
dtHandshakeTracer ∷ Tracer m (HandshakeTr ntnAddr ntnVersion)
Handshake protocol tracer
dtLocalMuxTracer ∷ Tracer m (WithMuxBearer (ConnectionId ntcAddr) MuxTrace)
Mux tracer for local clients
dtLocalHandshakeTracer ∷ Tracer m (HandshakeTr ntcAddr ntcVersion)
Handshake protocol tracer for local clients
dtDiffusionInitializationTracer ∷ Tracer m (InitializationTracer ntnAddr ntcAddr)
Diffusion initialisation tracer
dtLedgerPeersTracer ∷ Tracer m TraceLedgerPeers
Ledger Peers tracer

nullTracers ∷ Applicative m ⇒ Tracers ntnAddr ntnVersion ntcAddr ntcVersion m Source #

data ExtraTracers (p2p ∷ P2P) where Source #

Tracers which depend on p2p mode.

Constructors

P2PTracers ∷ TracersExtra RemoteAddress NodeToNodeVersion NodeToNodeVersionData LocalAddress NodeToClientVersion NodeToClientVersionData IOException IO → ExtraTracers 'P2P
NonP2PTracers ∷ TracersExtra → ExtraTracers 'NonP2P

data Failure ntnAddr Source #

Instances

Instances details

Eq ntnAddr ⇒ Eq (Failure ntnAddr) Source #
Instance details Defined in Ouroboros.Network.Diffusion.Common Methods (==) ∷ Failure ntnAddr → Failure ntnAddr → Bool Source # (/=) ∷ Failure ntnAddr → Failure ntnAddr → Bool Source #
Show ntnAddr ⇒ Show (Failure ntnAddr) Source #
Instance details Defined in Ouroboros.Network.Diffusion.Common Methods showsPrec ∷ Int → Failure ntnAddr → ShowS Source # show ∷ Failure ntnAddr → String Source # showList ∷ [Failure ntnAddr] → ShowS Source #
(Typeable ntnAddr, Show ntnAddr) ⇒ Exception (Failure ntnAddr) Source #
Instance details Defined in Ouroboros.Network.Diffusion.Common Methods toException ∷ Failure ntnAddr → SomeException Source # fromException ∷ SomeException → Maybe (Failure ntnAddr) Source # displayException ∷ Failure ntnAddr → String Source #

data Arguments ntnFd ntnAddr ntcFd ntcAddr Source #

Common DiffusionArguments interface between P2P and NonP2P

Constructors

Arguments

Fields

daIPv4Address ∷ Maybe (Either ntnFd ntnAddr)
an IPv4 socket ready to accept connections or an IPv4 addresses
daIPv6Address ∷ Maybe (Either ntnFd ntnAddr)
an IPV4 socket ready to accept connections or an IPv6 addresses
daLocalAddress ∷ Maybe (Either ntcFd ntcAddr)
an AF_UNIX socket ready to accept connections or an AF_UNIX socket path
daAcceptedConnectionsLimit ∷ AcceptedConnectionsLimit
parameters for limiting number of accepted connections
daMode ∷ DiffusionMode
run in initiator only mode

data ExtraArguments (p2p ∷ P2P) m where Source #

Diffusion arguments which depend on p2p mode.

Constructors

P2PArguments ∷ ArgumentsExtra m → ExtraArguments 'P2P m
NonP2PArguments ∷ ArgumentsExtra → ExtraArguments 'NonP2P m

data Applications ntnAddr ntnVersion ntnVersionData ntcAddr ntcVersion ntcVersionData m Source #

Versioned mini-protocol bundles run on a negotiated connection.

Constructors

Applications

Fields

daApplicationInitiatorMode ∷ Versions ntnVersion ntnVersionData (OuroborosBundle InitiatorMode ntnAddr ByteString m () Void)
NodeToNode initiator applications for initiator only mode.
TODO: we should accept one or the other, but not both: daApplicationInitiatorMode, daApplicationInitiatorResponderMode.
daApplicationInitiatorResponderMode ∷ Versions ntnVersion ntnVersionData (OuroborosBundle InitiatorResponderMode ntnAddr ByteString m () ())
NodeToNode initiator & responder applications for bidirectional mode.
daLocalResponderApplication ∷ Versions ntcVersion ntcVersionData (OuroborosApplication ResponderMode ntcAddr ByteString m Void ())
NodeToClient responder application (server role)
daLedgerPeersCtx ∷ LedgerPeersConsensusInterface m
Interface used to get peers from the current ledger.
TODO: it should be in InterfaceExtra

data ExtraApplications (p2p ∷ P2P) ntnAddr m where Source #

Application data which depend on p2p mode.

Constructors

P2PApplications ∷ ApplicationsExtra ntnAddr m → ExtraApplications 'P2P ntnAddr m
NonP2PApplications ∷ ApplicationsExtra → ExtraApplications 'NonP2P ntnAddr m

Run data diffusion

run ∷ ∀ (p2p ∷ P2P). Tracers RemoteAddress NodeToNodeVersion LocalAddress NodeToClientVersion IO → ExtraTracers p2p → Arguments Socket RemoteAddress LocalSocket LocalAddress → ExtraArguments p2p IO → Applications RemoteAddress NodeToNodeVersion NodeToNodeVersionData LocalAddress NodeToClientVersion NodeToClientVersionData IO → ExtraApplications p2p RemoteAddress IO → IO () Source #

Run data diffusion in either P2P or NonP2P mode.

Re-exports

type AbstractTransitionTrace peerAddr = TransitionTrace' peerAddr AbstractState Source #