Moduleouroboros-network-1.2.0.0

Ouroboros.Network.Diffusion

30 types
7 values

Packageouroboros-network-1.2.0.0
Exports40
LicenceApache-2.0

valuenoBindForkPolicy :: ForkPolicy peerAddr

valueresponderForkPolicy

:: Hashable peerAddr
=> Int
-> Int
-> ForkPolicy peerAddr

valuemkInterfaces

:: IOManager
-> Tracer IO (DiffusionTracer ntnAddr LocalAddress)
-> DiffTime
-> IO (Interfaces Socket RemoteAddress LocalSocket LocalAddress Resolver IO)

valuerun

:: (Monoid extraPeers, Eq extraFlags, Exception exception, NFData ntnVersion, Typeable ntnVersion, Ord ntnVersion, PrettyShow ntnVersion, NFData ntnVersionData, PrettyShow ntnVersionData, NFData ntcVersion, Ord ntcVersion, NFData ntcVersionData, NFData a, SupportsPeerSelectionState extraPeers RemoteAddress)
=> Arguments extraState extraDebugState extraFlags extraPeers extraAPI extraChurnArgs exception Resolver IO Socket RemoteAddress ntnVersion ntnVersionData LocalAddress ntcVersion ntcVersionData
-> Tracers RemoteAddress ntnVersion ntnVersionData LocalAddress ntcVersion ntcVersionData extraState extraDebugState extraFlags extraPeers IO
-> Configuration extraFlags IO Socket RemoteAddress LocalSocket LocalAddress
-> Applications RemoteAddress ntnVersion ntnVersionData LocalAddress ntcVersion ntcVersionData extraFlags IO a
-> IO Void

valuerunM

:: (Alternative (STM m), MonadAsync m, MonadDelay m, MonadEvaluate m, MonadFix m, MonadFork m, MonadLabelledSTM m, MonadTraceSTM m, MonadMask m, MonadThrow (STM m), MonadTime m, MonadTimer m, MonadMVar m, Typeable ntnAddr, Hashable ntnAddr, PrettyShow ntnAddr, NFData ntnVersion, Typeable ntnVersion, Ord ntnVersion, Show ntnVersion, NFData ntnVersionData, Show ntnVersionData, Typeable ntcAddr, Ord ntcAddr, PrettyShow ntcAddr, NFData ntcVersion, Ord ntcVersion, NFData ntcVersionData, Monoid extraPeers, Eq extraFlags, Exception exception, NFData a, SupportsPeerSelectionState extraPeers ntnAddr)
=> Interfaces ntnFd ntnAddr ntcFd ntcAddr resolver m
-> Tracers ntnAddr ntnVersion ntnVersionData ntcAddr ntcVersion ntcVersionData extraState extraDebugState extraFlags extraPeers m
-> Arguments extraState extraDebugState extraFlags extraPeers extraAPI extraChurnArgs exception resolver m ntnFd ntnAddr ntnVersion ntnVersionData ntcAddr ntcVersion ntcVersionData
-> Configuration extraFlags m ntnFd ntnAddr ntcFd ntcAddr
-> Applications ntnAddr ntnVersion ntnVersionData ntcAddr ntcVersion ntcVersionData extraFlags m a
-> m Void

valuesocketAddressType :: SockAddr -> Maybe AddressType

value

nullTracers :: Monad m => Tracers ntnAddr ntnVersion ntnVersionData ntcAddr ntcVersion ntcVersionData extraState extraDebugState extraFlags extraPeers m

typetype AbstractTransitionTrace peerAddr = TransitionTrace' peerAddr AbstractState

typetype RemoteTransitionTrace peerAddr = TransitionTrace' peerAddr (Maybe RemoteSt)

newtypenewtype ForkPolicy peerAddr

datadata Applications ntnAddr ntnVersion ntnVersionData ntcAddr ntcVersion ntcVersionData extraFlags (m :: Type -> Type) a

Constructors

Applications
- daApplicationInitiatorMode :: Versions ntnVersion ntnVersionData (OuroborosBundleWithExpandedCtx 'InitiatorMode ntnAddr extraFlags ByteString m a Void)
- daApplicationInitiatorResponderMode :: Versions ntnVersion ntnVersionData (OuroborosBundleWithExpandedCtx 'InitiatorResponderMode ntnAddr extraFlags ByteString m a ())
- daLocalResponderApplication :: Versions ntcVersion ntcVersionData (OuroborosApplicationWithMinimalCtx 'ResponderMode ntcAddr ByteString m Void ())
- daRethrowPolicy :: RethrowPolicy
- daReturnPolicy :: ReturnPolicy a
- daRepromoteErrorDelay :: RepromoteDelay
- daLocalRethrowPolicy :: RethrowPolicy
- daPeerSelectionPolicy :: PeerSelectionPolicy ntnAddr m
- daPeerSharingRegistry :: PeerSharingRegistry ntnAddr m

data

data Arguments extraState extraDebugState extraFlags extraPeers extraAPI extraChurnArgs exception resolver (m :: Type -> Type) ntnFd ntnAddr ntnVersion ntnVersionData ntcAddr ntcVersion ntcVersionData

Constructors

Arguments
- daNtnDataFlow :: ntnVersionData -> DataFlow
- daNtnPeerSharing :: ntnVersionData -> PeerSharing
- daUpdateVersionData :: ntnVersionData -> DiffusionMode -> ntnVersionData
- daNtnHandshakeArguments :: HandshakeArguments (ConnectionId ntnAddr) ntnVersion ntnVersionData m
- daNtcHandshakeArguments :: HandshakeArguments (ConnectionId ntcAddr) ntcVersion ntcVersionData m
- daLedgerPeersCtx :: LedgerPeersConsensusInterface extraAPI m
- daEmptyExtraState :: extraState
- daEmptyExtraCounters :: ViewExtraPeers extraPeers
- daExtraPeersAPI :: PublicExtraPeersAPI extraPeers ntnAddr
- daInstallSigUSR1Handler :: forall (mode :: Mode) x y. NodeToNodeConnectionManager mode ntnFd ntnAddr extraFlags ntnVersionData ntnVersion m x y -> StrictTVar m (PeerSelectionState extraState extraFlags extraPeers ntnAddr (NodeToNodePeerConnectionHandle mode ntnAddr extraFlags ntnVersionData m x y)) -> m ()
- daPeerSelectionGovernorArgs :: forall (muxMode :: Mode) responderCtx bytes a b. PeerSelectionGovernorArgs extraState extraDebugState extraFlags extraPeers extraAPI ntnAddr (PeerConnectionHandle muxMode responderCtx ntnAddr extraFlags ntnVersionData bytes m a b) exception m
- daToExtraPeers :: Map ntnAddr PeerAdvertise -> extraPeers
- daRequestPublicRootPeers :: Maybe (PeerActionsDNS ntnAddr resolver m -> DNSSemaphore m -> (Map ntnAddr PeerAdvertise -> extraPeers) -> (NumberOfPeers -> SomeLedgerPeersKind -> m (Maybe (Set ntnAddr, DiffTime))) -> SomeLedgerPeersKind -> StdGen -> Int -> m (PublicRootPeers extraPeers ntnAddr, DiffTime))
- daPeerChurnGovernor :: PeerChurnArgs m extraChurnArgs extraDebugState extraFlags extraPeers extraAPI ntnAddr -> m Void
- daExtraChurnArgs :: extraChurnArgs
- daSRVPrefix :: SRVPrefix

datadata Configuration extraFlags (m :: Type -> Type) ntnFd ntnAddr ntcFd ntcAddr

Constructors

Configuration
- dcIPv4Address :: Maybe (Either ntnFd ntnAddr)
- dcIPv6Address :: Maybe (Either ntnFd ntnAddr)
- dcLocalAddress :: Maybe (Either ntcFd ntcAddr)
- dcAcceptedConnectionsLimit :: AcceptedConnectionsLimit
- dcMode :: DiffusionMode
- dcPublicPeerSelectionVar :: StrictTVar m (PublicPeerSelectionState ntnAddr)
- dcPeerSelectionTargets :: PeerSelectionTargets
- dcReadLocalRootPeers :: STM m (Config extraFlags RelayAccessPoint)
- dcReadPublicRootPeers :: STM m (Map RelayAccessPoint PeerAdvertise)
- dcReadLedgerPeerSnapshot :: STM m (Maybe (LedgerPeerSnapshot BigLedgerPeers))
- dcReadUseLedgerPeers :: STM m UseLedgerPeers
- dcPeerSharing :: PeerSharing
- dcProtocolIdleTimeout :: DiffTime
- dcTimeWaitTimeout :: DiffTime
- dcDeadlineChurnInterval :: DiffTime
- dcBulkChurnInterval :: DiffTime
- dcMuxForkPolicy :: ForkPolicy ntnAddr
- dcLocalMuxForkPolicy :: ForkPolicy ntcAddr
- dcEgressPollInterval :: DiffTime

datadata DiffusionTracer ntnAddr ntcAddr

Constructors

RunServer (NonEmpty ntnAddr)
RunLocalServer ntcAddr
UsingSystemdSocket ntcAddr
CreateSystemdSocketForSnocketPath ntcAddr
CreatedLocalSocket ntcAddr
ConfiguringLocalSocket ntcAddr FileDescriptor
ConfiguredLocalSocket ntcAddr FileDescriptor
ListeningLocalSocket ntcAddr FileDescriptor
LocalSocketUp ntcAddr FileDescriptor
InsecureLocalSocketDirectory ntcAddr Word32
InsecureLocalSocketPermissions ntcAddr Word32
CreatingServerSocket ntnAddr
ConfiguringServerSocket ntnAddr
ListeningServerSocket ntnAddr
ServerSocketUp ntnAddr
UnsupportedLocalSystemdSocket ntnAddr
UnsupportedReadySocketCase
DiffusionErrored SomeException
SystemdSocketConfiguration SystemdSocketTracer

Instances1Show

(Show ntcAddr, Show ntnAddr) => Show (DiffusionTracer ntnAddr ntcAddr)Defined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types

datadata Failure where

Constructors

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

Instances2Show, Exception

Show FailureDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
Exception FailureDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types

datadata Interfaces ntnFd ntnAddr ntcFd ntcAddr resolver (m :: Type -> Type)

Constructors

Interfaces
- diNtnSnocket :: Snocket m ntnFd ntnAddr
- diNtnBearer :: MakeBearer m ntnFd
- diWithBuffer :: (Maybe (ReadBuffer m) -> m ()) -> m ()
- diNtnConfigureSocket :: ntnFd -> Maybe ntnAddr -> m ()
- diNtnConfigureSystemdSocket :: ntnFd -> ntnAddr -> m ()
- diNtnAddressType :: ntnAddr -> Maybe AddressType
- diNtnToPeerAddr :: IP -> PortNumber -> ntnAddr
- diNtcSnocket :: Snocket m ntcFd ntcAddr
- diNtcBearer :: MakeBearer m ntcFd
- diNtcGetFileDescriptor :: ntcFd -> m FileDescriptor
- diNtcConfigureSocketFile :: ntcAddr -> m ()
- diRng :: StdGen
- diDnsActions :: Tracer m DNSTrace -> DNSLookupType -> (IP -> PortNumber -> ntnAddr) -> DNSActions ntnAddr resolver m
- diConnStateIdSupply :: ConnStateIdSupply m

type

type MkNodeToClientConnectionHandler ntcFd ntcAddr ntcVersion ntcVersionData (m :: Type -> Type) = (StrictTVar m (StrictMaybe ResponderCounters) -> Tracer m (WithBearer (ConnectionId ntcAddr) Trace)) -> ConnectionHandler 'ResponderMode (ConnectionHandlerTrace ntcVersion ntcVersionData) ntcFd ntcAddr (NodeToClientHandle ntcAddr ntcVersionData m) (NodeToClientHandlerError ntcVersion) ntcVersion ntcVersionData m

datadata NoExtraAPI

NoExtraAPI

Instances2Eq, Show

Eq NoExtraAPIDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
Show NoExtraAPIDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types

datadata NoExtraChurnArgs

NoExtraChurnArgs

Instances2Eq, Show

Eq NoExtraChurnArgsDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
Show NoExtraChurnArgsDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types

datadata NoExtraConfig

NoExtraConfig

Instances2Eq, Show

Eq NoExtraConfigDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
Show NoExtraConfigDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types

datadata NoExtraDebugState

NoExtraDebugState

Instances2Eq, Show

Eq NoExtraDebugStateDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
Show NoExtraDebugStateDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types

datadata NoExtraFlags

NoExtraFlags

Instances2Eq, Show

Eq NoExtraFlagsDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
Show NoExtraFlagsDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types

datadata NoExtraPeers peeraddr

NoExtraPeers

Instances9Eq, Show, Semigroup, Monoid, SupportsPeerSelectionState, ViewExtraPeers, …

Eq (NoExtraPeers peeraddr)Defined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
Eq (ViewExtraPeers (NoExtraPeers peeraddr))Defined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
Show (NoExtraPeers peeraddr)Defined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
Show (ToExtraTrace (NoExtraPeers peeraddr))Defined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
Semigroup (NoExtraPeers peeraddr)Defined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
Monoid (NoExtraPeers peeraddr)Defined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
(Ord peeraddr, Show peeraddr) => SupportsPeerSelectionState (NoExtraPeers peeraddr) peeraddrDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
data ViewExtraPeers (NoExtraPeers peeraddr)
- NoExtraView
Defined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
data ToExtraTrace (NoExtraPeers peeraddr)Defined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types

datadata NoExtraState

NoExtraState

Instances2Eq, Show

Eq NoExtraStateDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
Show NoExtraStateDefined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types

type

type NodeToClientHandle ntcAddr versionData (m :: Type -> Type) = HandleWithMinimalCtx 'ResponderMode ntcAddr versionData ByteString m Void ()

typetype NodeToClientHandleError ntcVersion = HandlerError ntcVersion

Deprecated. Use NodeToClientHandlerError

typetype NodeToClientHandlerError ntcVersion = HandlerError ntcVersion

type

type NodeToNodeConnectionManager (mode :: Mode) ntnFd ntnAddr extraFlags ntnVersionData ntnVersion (m :: Type -> Type) a b = ConnectionManager mode ntnFd ntnAddr (NodeToNodeHandle mode ntnAddr extraFlags ntnVersionData m a b) (HandlerError ntnVersion) m

type

type NodeToNodeHandle (mode :: Mode) ntnAddr extraFlags ntnVersionData (m :: Type -> Type) a b = HandleWithExpandedCtx mode ntnAddr extraFlags ntnVersionData ByteString m a b

type

type NodeToNodePeerConnectionHandle (mode :: Mode) ntnAddr extraFlags ntnVersionData (m :: Type -> Type) a b = PeerConnectionHandle mode (ResponderContext ntnAddr) ntnAddr extraFlags ntnVersionData ByteString m a b

type

type NodeToNodePeerSelectionActions extraState extraFlags extraPeers extraAPI (mode :: Mode) ntnAddr ntnVersionData (m :: Type -> Type) a b = PeerSelectionActions extraState extraFlags extraPeers extraAPI ntnAddr (NodeToNodePeerConnectionHandle mode ntnAddr extraFlags ntnVersionData m a b) m

type

type OuroborosDebugPeerSelection extraState extraFlags peeraddr = DebugPeerSelection extraState extraFlags (NoExtraPeers peeraddr) peeraddr

typetype OuroborosPeerSelectionCounters peeraddr = PeerSelectionCounters (ViewExtraPeers (NoExtraPeers peeraddr))

type

type OuroborosTracePeerSelection extraDebugState extraFlags peeraddr = TracePeerSelection extraDebugState extraFlags (NoExtraPeers peeraddr) peeraddr

data

data Tracers ntnAddr ntnVersion ntnVersionData ntcAddr ntcVersion ntcVersionData extraState extraDebugState extraFlags extraPeers (m :: Type -> Type)

Constructors

Tracers
- dtMuxTracer :: Tracer m (WithBearer (ConnectionId ntnAddr) Trace)
- dtChannelTracer :: Tracer m (WithBearer (ConnectionId ntnAddr) ChannelTrace)
- dtBearerTracer :: Tracer m (WithBearer (ConnectionId ntnAddr) BearerTrace)
- dtHandshakeTracer :: Tracer m (WithBearer (ConnectionId ntnAddr) (TraceSendRecv (Handshake ntnVersion Term)))
- dtLocalMuxTracer :: Tracer m (WithBearer (ConnectionId ntcAddr) Trace)
- dtLocalChannelTracer :: Tracer m (WithBearer (ConnectionId ntcAddr) ChannelTrace)
- dtLocalBearerTracer :: Tracer m (WithBearer (ConnectionId ntcAddr) BearerTrace)
- dtLocalHandshakeTracer :: Tracer m (WithBearer (ConnectionId ntcAddr) (TraceSendRecv (Handshake ntcVersion Term)))
- dtDiffusionTracer :: Tracer m (DiffusionTracer ntnAddr ntcAddr)
- dtTraceLocalRootPeersTracer :: Tracer m (TraceLocalRootPeers extraFlags ntnAddr)
- dtTracePublicRootPeersTracer :: Tracer m TracePublicRootPeers
- dtTraceLedgerPeersTracer :: Tracer m TraceLedgerPeers
- dtTracePeerSelectionTracer :: Tracer m (TracePeerSelection extraDebugState extraFlags extraPeers ntnAddr)
- dtDebugPeerSelectionTracer :: Tracer m (DebugPeerSelection extraState extraFlags extraPeers ntnAddr)
- dtTracePeerSelectionCounters :: Tracer m (PeerSelectionCounters (ViewExtraPeers extraPeers))
- dtPeerSelectionActionsTracer :: Tracer m (PeerSelectionActionsTrace ntnAddr ntnVersion)
- dtConnectionManagerTracer :: Tracer m (Trace ntnAddr (ConnectionHandlerTrace ntnVersion ntnVersionData))
- dtConnectionManagerTransitionTracer :: Tracer m (AbstractTransitionTrace ConnStateId)
- dtServerTracer :: Tracer m (Trace ntnAddr)
- dtInboundGovernorTracer :: Tracer m (Trace ntnAddr)
- dtInboundGovernorTransitionTracer :: Tracer m (RemoteTransitionTrace ntnAddr)
- dtDnsTracer :: Tracer m DNSTrace
- dtLocalConnectionManagerTracer :: Tracer m (Trace ntcAddr (ConnectionHandlerTrace ntcVersion ntcVersionData))
- dtLocalServerTracer :: Tracer m (Trace ntcAddr)
- dtLocalInboundGovernorTracer :: Tracer m (Trace ntcAddr)

familydata family ViewExtraPeers extraPeers

Instances2Eq, ViewExtraPeers

Eq (ViewExtraPeers (NoExtraPeers peeraddr))Defined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
data ViewExtraPeers (NoExtraPeers peeraddr)
- NoExtraView
Defined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types

familydata family ViewExtraPeers extraPeers

Instances2Eq, ViewExtraPeers

Eq (ViewExtraPeers (NoExtraPeers peeraddr))Defined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types
data ViewExtraPeers (NoExtraPeers peeraddr)
- NoExtraView
Defined in ouroboros-network-1.2.0.0 · Ouroboros.Network.Diffusion.Types

constructorNoExtraView

datadata DiffusionMode

InitiatorOnlyDiffusionMode InitiatorAndResponderDiffusionMode

typetype SRVPrefix = Domain