Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Diffusion

Contents

Common API
Run data diffusion
Re-exports

Synopsis

data P2P
- = P2P
- | NonP2P
data DiffusionTracer 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
- | SystemdSocketConfiguration SystemdSocketTracer
data Tracers ntnAddr ntnVersion ntcAddr ntcVersion (m :: Type -> Type) = Tracers {
- dtMuxTracer :: Tracer m (WithBearer (ConnectionId ntnAddr) Trace)
- dtHandshakeTracer :: Tracer m (HandshakeTr ntnAddr ntnVersion)
- dtLocalMuxTracer :: Tracer m (WithBearer (ConnectionId ntcAddr) Trace)
- dtLocalHandshakeTracer :: Tracer m (HandshakeTr ntcAddr ntcVersion)
- dtDiffusionTracer :: Tracer m (DiffusionTracer ntnAddr ntcAddr)
}
nullTracers :: forall (m :: Type -> Type) ntnAddr ntnVersion ntcAddr ntcVersion. 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 where
- UnsupportedReadySocket :: Failure
- UnexpectedIPv4Address :: forall ntnAddr. (Show ntnAddr, Typeable ntnAddr) => ntnAddr -> Failure
- UnexpectedIPv6Address :: forall ntnAddr. (Show ntnAddr, Typeable ntnAddr) => ntnAddr -> Failure
- NoSocket :: Failure
- DiffusionError :: SomeException -> Failure
data Arguments (m :: Type -> Type) ntnFd ntnAddr ntcFd ntcAddr = Arguments {
- daIPv4Address :: Maybe (Either ntnFd ntnAddr)
- daIPv6Address :: Maybe (Either ntnFd ntnAddr)
- daLocalAddress :: Maybe (Either ntcFd ntcAddr)
- daAcceptedConnectionsLimit :: AcceptedConnectionsLimit
- daMode :: DiffusionMode
- daPublicPeerSelectionVar :: StrictTVar m (PublicPeerSelectionState ntnAddr)
}
data ExtraArguments (p2p :: P2P) (m :: Type -> Type) where
- P2PArguments :: forall (m :: Type -> Type). ArgumentsExtra m -> ExtraArguments 'P2P m
- NonP2PArguments :: forall (m :: Type -> Type). ArgumentsExtra -> ExtraArguments 'NonP2P m
data Applications ntnAddr ntnVersion ntnVersionData ntcAddr ntcVersion ntcVersionData (m :: Type -> Type) a = Applications {
- daApplicationInitiatorMode :: Versions ntnVersion ntnVersionData (OuroborosBundleWithExpandedCtx 'InitiatorMode ntnAddr ByteString m a Void)
- daApplicationInitiatorResponderMode :: Versions ntnVersion ntnVersionData (OuroborosBundleWithExpandedCtx 'InitiatorResponderMode ntnAddr ByteString m a ())
- daLocalResponderApplication :: Versions ntcVersion ntcVersionData (OuroborosApplicationWithMinimalCtx 'ResponderMode ntcAddr ByteString m Void ())
- daLedgerPeersCtx :: LedgerPeersConsensusInterface m
- daUpdateOutboundConnectionsState :: OutboundConnectionsState -> STM m ()
}
data ExtraApplications (p2p :: P2P) ntnAddr (m :: Type -> Type) a where
- P2PApplications :: forall ntnAddr (m :: Type -> Type) a. ApplicationsExtra ntnAddr m a -> ExtraApplications 'P2P ntnAddr m a
- NonP2PApplications :: forall ntnAddr (m :: Type -> Type) a. ApplicationsExtra -> ExtraApplications 'NonP2P ntnAddr m a
run :: forall (p2p :: P2P) a. Tracers RemoteAddress NodeToNodeVersion LocalAddress NodeToClientVersion IO -> ExtraTracers p2p -> Arguments IO Socket RemoteAddress LocalSocket LocalAddress -> ExtraArguments p2p IO -> Applications RemoteAddress NodeToNodeVersion NodeToNodeVersionData LocalAddress NodeToClientVersion NodeToClientVersionData IO a -> ExtraApplications p2p RemoteAddress IO a -> IO ()
type AbstractTransitionTrace peerAddr = TransitionTrace' peerAddr AbstractState
data PublicPeerSelectionState peeraddr
makePublicPeerSelectionStateVar :: (MonadSTM m, Ord peeraddr) => m (StrictTVar m (PublicPeerSelectionState peeraddr))

Common API

data P2P Source #

Promoted data types.

Constructors

P2P
NonP2P

data DiffusionTracer ntnAddr ntcAddr Source #

The DiffusionTracer logs

diffusion initialisation messages
terminal errors thrown by diffusion

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
SystemdSocketConfiguration SystemdSocketTracer

Instances

Instances details

(Show ntcAddr, Show ntnAddr) => Show (DiffusionTracer ntnAddr ntcAddr) Source #
Instance details Defined in Ouroboros.Network.Diffusion.Common Methods showsPrec :: Int -> DiffusionTracer ntnAddr ntcAddr -> ShowS # show :: DiffusionTracer ntnAddr ntcAddr -> String # showList :: [DiffusionTracer ntnAddr ntcAddr] -> ShowS #

data Tracers ntnAddr ntnVersion ntcAddr ntcVersion (m :: Type -> Type) Source #

Common DiffusionTracers interface between P2P and NonP2P

Constructors

Tracers

Fields

dtMuxTracer :: Tracer m (WithBearer (ConnectionId ntnAddr) Trace)
Mux tracer
dtHandshakeTracer :: Tracer m (HandshakeTr ntnAddr ntnVersion)
Handshake protocol tracer
dtLocalMuxTracer :: Tracer m (WithBearer (ConnectionId ntcAddr) Trace)
Mux tracer for local clients
dtLocalHandshakeTracer :: Tracer m (HandshakeTr ntcAddr ntcVersion)
Handshake protocol tracer for local clients
dtDiffusionTracer :: Tracer m (DiffusionTracer ntnAddr ntcAddr)
Diffusion initialisation tracer

nullTracers :: forall (m :: Type -> Type) ntnAddr ntnVersion ntcAddr ntcVersion. 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 where Source #

Constructors

UnsupportedReadySocket :: Failure
UnexpectedIPv4Address :: forall ntnAddr. (Show ntnAddr, Typeable ntnAddr) => ntnAddr -> Failure
UnexpectedIPv6Address :: forall ntnAddr. (Show ntnAddr, Typeable ntnAddr) => ntnAddr -> Failure
NoSocket :: Failure
DiffusionError :: SomeException -> Failure

Instances

Instances details

Exception Failure Source #
Instance details Defined in Ouroboros.Network.Diffusion.Common Methods toException :: Failure -> SomeException # fromException :: SomeException -> Maybe Failure # displayException :: Failure -> String # backtraceDesired :: Failure -> Bool #
Show Failure Source #
Instance details Defined in Ouroboros.Network.Diffusion.Common Methods showsPrec :: Int -> Failure -> ShowS # show :: Failure -> String # showList :: [Failure] -> ShowS #

data Arguments (m :: Type -> Type) 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 IPv6 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
daPublicPeerSelectionVar :: StrictTVar m (PublicPeerSelectionState ntnAddr)
public peer selection state
It is created outside of diffusion, since it is needed to create some apps (e.g. peer sharing).

data ExtraArguments (p2p :: P2P) (m :: Type -> Type) where Source #

Diffusion arguments which depend on p2p mode.

Constructors

P2PArguments :: forall (m :: Type -> Type). ArgumentsExtra m -> ExtraArguments 'P2P m
NonP2PArguments :: forall (m :: Type -> Type). ArgumentsExtra -> ExtraArguments 'NonP2P m

data Applications ntnAddr ntnVersion ntnVersionData ntcAddr ntcVersion ntcVersionData (m :: Type -> Type) a Source #

Versioned mini-protocol bundles run on a negotiated connection.

Constructors

Applications

Fields

daApplicationInitiatorMode :: Versions ntnVersion ntnVersionData (OuroborosBundleWithExpandedCtx 'InitiatorMode ntnAddr ByteString m a Void)
NodeToNode initiator applications for initiator only mode.
TODO: we should accept one or the other, but not both: daApplicationInitiatorMode, daApplicationInitiatorResponderMode.
Even in non-p2p mode we use p2p apps.
daApplicationInitiatorResponderMode :: Versions ntnVersion ntnVersionData (OuroborosBundleWithExpandedCtx 'InitiatorResponderMode ntnAddr ByteString m a ())
NodeToNode initiator & responder applications for bidirectional mode.
daLocalResponderApplication :: Versions ntcVersion ntcVersionData (OuroborosApplicationWithMinimalCtx 'ResponderMode ntcAddr ByteString m Void ())
NodeToClient responder application (server role)
Because p2p mode does not infect local connections we we use non-p2p apps.
daLedgerPeersCtx :: LedgerPeersConsensusInterface m
Interface used to get peers from the current ledger.
TODO: it should be in InterfaceExtra
daUpdateOutboundConnectionsState :: OutboundConnectionsState -> STM m ()
Callback provided by consensus to inform it if the node is connected to only local roots or also some external peers.
This is useful in order for the Bootstrap State Machine to simply refuse to transition from TooOld to YoungEnough while it only has local peers.

data ExtraApplications (p2p :: P2P) ntnAddr (m :: Type -> Type) a where Source #

Application data which depend on p2p mode.

Constructors

P2PApplications :: forall ntnAddr (m :: Type -> Type) a. ApplicationsExtra ntnAddr m a -> ExtraApplications 'P2P ntnAddr m a
NonP2PApplications :: forall ntnAddr (m :: Type -> Type) a. ApplicationsExtra -> ExtraApplications 'NonP2P ntnAddr m a

Run data diffusion

run :: forall (p2p :: P2P) a. Tracers RemoteAddress NodeToNodeVersion LocalAddress NodeToClientVersion IO -> ExtraTracers p2p -> Arguments IO Socket RemoteAddress LocalSocket LocalAddress -> ExtraArguments p2p IO -> Applications RemoteAddress NodeToNodeVersion NodeToNodeVersionData LocalAddress NodeToClientVersion NodeToClientVersionData IO a -> ExtraApplications p2p RemoteAddress IO a -> IO () Source #

Run data diffusion in either P2P or NonP2P mode.

Re-exports

type AbstractTransitionTrace peerAddr = TransitionTrace' peerAddr AbstractState #

data PublicPeerSelectionState peeraddr Source #

Public PeerSelectionState that can be accessed by Peer Sharing mechanisms without any problem.

This data type should not expose too much information and keep only essential data needed for computing the peer sharing request result

makePublicPeerSelectionStateVar :: (MonadSTM m, Ord peeraddr) => m (StrictTVar m (PublicPeerSelectionState peeraddr)) Source #