Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.NodeToNode

Contents

P2P Governor
Subscription Workers
Re-exports
- Error Policies and Peer state
- Traces
For Consensus ThreadNet Tests

Description

This is the starting point for a module that will bring together the overall node to node protocol, as a collection of mini-protocols.

Synopsis

nodeToNodeProtocols :: MiniProtocolParameters -> ( ConnectionId addr -> STM m ControlMessage -> NodeToNodeProtocols muxMode bytes m a b) -> NodeToNodeVersion -> OuroborosBundle muxMode addr bytes m a b
data NodeToNodeProtocols appType bytes m a b = NodeToNodeProtocols {
- chainSyncProtocol :: RunMiniProtocol appType bytes m a b
- blockFetchProtocol :: RunMiniProtocol appType bytes m a b
- txSubmissionProtocol :: RunMiniProtocol appType bytes m a b
- keepAliveProtocol :: RunMiniProtocol appType bytes m a b
}
data MiniProtocolParameters = MiniProtocolParameters {
- chainSyncPipeliningHighMark :: ! Word32
- chainSyncPipeliningLowMark :: ! Word32
- blockFetchPipeliningMax :: ! Word
- txSubmissionMaxUnacked :: ! Word16
}
chainSyncProtocolLimits :: MiniProtocolParameters -> MiniProtocolLimits
blockFetchProtocolLimits :: MiniProtocolParameters -> MiniProtocolLimits
txSubmissionProtocolLimits :: MiniProtocolParameters -> MiniProtocolLimits
keepAliveProtocolLimits :: MiniProtocolParameters -> MiniProtocolLimits
defaultMiniProtocolParameters :: MiniProtocolParameters
data NodeToNodeVersion
- = NodeToNodeV_7
- | NodeToNodeV_8
- | NodeToNodeV_9
- | NodeToNodeV_10
data NodeToNodeVersionData = NodeToNodeVersionData {
- networkMagic :: ! NetworkMagic
- diffusionMode :: ! DiffusionMode
}
data NetworkConnectTracers addr vNumber = NetworkConnectTracers {
- nctMuxTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) MuxTrace )
- nctHandshakeTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) ( TraceSendRecv ( Handshake vNumber Term )))
}
nullNetworkConnectTracers :: NetworkConnectTracers addr vNumber
connectTo :: Snocket IO Socket SockAddr -> NetworkConnectTracers SockAddr NodeToNodeVersion -> Versions NodeToNodeVersion NodeToNodeVersionData ( OuroborosApplication InitiatorMode SockAddr ByteString IO a b) -> Maybe SockAddr -> SockAddr -> IO ()
data NetworkServerTracers addr vNumber = NetworkServerTracers {
- nstMuxTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) MuxTrace )
- nstHandshakeTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) ( TraceSendRecv ( Handshake vNumber Term )))
- nstErrorPolicyTracer :: Tracer IO ( WithAddr addr ErrorPolicyTrace )
- nstAcceptPolicyTracer :: Tracer IO AcceptConnectionsPolicyTrace
}
nullNetworkServerTracers :: NetworkServerTracers addr vNumber
data NetworkMutableState addr = NetworkMutableState {
- nmsConnectionTable :: ConnectionTable IO addr
- nmsPeerStates :: StrictTVar IO ( PeerStates IO addr)
}
data AcceptedConnectionsLimit = AcceptedConnectionsLimit {
- acceptedConnectionsHardLimit :: ! Word32
- acceptedConnectionsSoftLimit :: ! Word32
- acceptedConnectionsDelay :: ! DiffTime
}
newNetworkMutableState :: IO ( NetworkMutableState addr)
newNetworkMutableStateSTM :: STM ( NetworkMutableState addr)
cleanNetworkMutableState :: NetworkMutableState addr -> IO ()
withServer :: SocketSnocket -> NetworkServerTracers SockAddr NodeToNodeVersion -> NetworkMutableState SockAddr -> AcceptedConnectionsLimit -> Socket -> Versions NodeToNodeVersion NodeToNodeVersionData ( OuroborosApplication ResponderMode SockAddr ByteString IO a b) -> ErrorPolicies -> IO Void
data DomainAccessPoint = DomainAccessPoint {
- dapDomain :: ! Domain
- dapPortNumber :: ! PortNumber
}
data PeerAdvertise
- = DoNotAdvertisePeer
- | DoAdvertisePeer
data PeerSelectionTargets = PeerSelectionTargets {
- targetNumberOfRootPeers :: ! Int
- targetNumberOfKnownPeers :: ! Int
- targetNumberOfEstablishedPeers :: ! Int
- targetNumberOfActivePeers :: ! Int
}
data IPSubscriptionTarget = IPSubscriptionTarget {
- ispIps :: ![ SockAddr ]
- ispValency :: ! Int
}
type NetworkIPSubscriptionTracers addr vNumber = NetworkSubscriptionTracers WithIPList addr vNumber
data NetworkSubscriptionTracers withIPList addr vNumber = NetworkSubscriptionTracers {
- nsMuxTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) MuxTrace )
- nsHandshakeTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) ( TraceSendRecv ( Handshake vNumber Term )))
- nsErrorPolicyTracer :: Tracer IO ( WithAddr addr ErrorPolicyTrace )
- nsSubscriptionTracer :: Tracer IO (withIPList ( SubscriptionTrace addr))
}
nullNetworkSubscriptionTracers :: NetworkSubscriptionTracers withIPList addr vNumber
data SubscriptionParams a target = SubscriptionParams {
- spLocalAddresses :: LocalAddresses SockAddr
- spConnectionAttemptDelay :: SockAddr -> Maybe DiffTime
- spErrorPolicies :: ErrorPolicies
- spSubscriptionTarget :: target
}
type IPSubscriptionParams a = SubscriptionParams a IPSubscriptionTarget
ipSubscriptionWorker :: forall mode x y. HasInitiator mode ~ True => SocketSnocket -> NetworkIPSubscriptionTracers SockAddr NodeToNodeVersion -> NetworkMutableState SockAddr -> IPSubscriptionParams () -> Versions NodeToNodeVersion NodeToNodeVersionData ( OuroborosApplication mode SockAddr ByteString IO x y) -> IO Void
data DnsSubscriptionTarget = DnsSubscriptionTarget {
- dstDomain :: ! Domain
- dstPort :: ! PortNumber
- dstValency :: ! Int
}
type DnsSubscriptionParams a = SubscriptionParams a DnsSubscriptionTarget
data NetworkDNSSubscriptionTracers vNumber addr = NetworkDNSSubscriptionTracers {
- ndstMuxTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) MuxTrace )
- ndstHandshakeTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) ( TraceSendRecv ( Handshake vNumber Term )))
- ndstErrorPolicyTracer :: Tracer IO ( WithAddr addr ErrorPolicyTrace )
- ndstSubscriptionTracer :: Tracer IO ( WithDomainName ( SubscriptionTrace addr))
- ndstDnsTracer :: Tracer IO ( WithDomainName DnsTrace )
}
nullNetworkDNSSubscriptionTracers :: NetworkDNSSubscriptionTracers vNumber peerid
dnsSubscriptionWorker :: forall mode x y. HasInitiator mode ~ True => SocketSnocket -> NetworkDNSSubscriptionTracers NodeToNodeVersion SockAddr -> NetworkMutableState SockAddr -> DnsSubscriptionParams () -> Versions NodeToNodeVersion NodeToNodeVersionData ( OuroborosApplication mode SockAddr ByteString IO x y) -> IO Void
newtype Versions vNum vData r = Versions {
- getVersions :: Map vNum ( Version vData r)
}
data DiffusionMode
- = InitiatorOnlyDiffusionMode
- | InitiatorAndResponderDiffusionMode
simpleSingletonVersions :: vNum -> vData -> r -> Versions vNum vData r
foldMapVersions :: ( Ord vNum, Foldable f, HasCallStack ) => (x -> Versions vNum extra r) -> f x -> Versions vNum extra r
combineVersions :: ( Ord vNum, Foldable f, HasCallStack ) => f ( Versions vNum extra r) -> Versions vNum extra r
nodeToNodeHandshakeCodec :: MonadST m => Codec ( Handshake NodeToNodeVersion Term ) DeserialiseFailure m ByteString
nodeToNodeVersionCodec :: CodecCBORTerm ( Text , Maybe Int ) NodeToNodeVersion
nodeToNodeCodecCBORTerm :: NodeToNodeVersion -> CodecCBORTerm Text NodeToNodeVersionData
data ConnectionId addr = ConnectionId {
- localAddress :: !addr
- remoteAddress :: !addr
}
type RemoteAddress = SockAddr
type RemoteConnectionId = ConnectionId RemoteAddress
data ProtocolLimitFailure
data Handshake (vNumber :: k) (vParams :: k1)
data LocalAddresses addr = LocalAddresses {
- laIpv4 :: Maybe addr
- laIpv6 :: Maybe addr
- laUnix :: Maybe addr
}
data Socket
isPipeliningEnabled :: NodeToNodeVersion -> Bool
data ErrorPolicies = ErrorPolicies {
- epAppErrorPolicies :: [ ErrorPolicy ]
- epConErrorPolicies :: [ ErrorPolicy ]
}
remoteNetworkErrorPolicy :: ErrorPolicies
localNetworkErrorPolicy :: ErrorPolicies
nullErrorPolicies :: ErrorPolicies
data ErrorPolicy where
- ErrorPolicy :: forall e. Exception e => (e -> Maybe ( SuspendDecision DiffTime )) -> ErrorPolicy
data SuspendDecision t
- = SuspendPeer !t !t
- | SuspendConsumer !t
- | Throw
data AcceptConnectionsPolicyTrace
- = ServerTraceAcceptConnectionRateLimiting DiffTime Int
- | ServerTraceAcceptConnectionHardLimit Word32
- | ServerTraceAcceptConnectionResume Int
data TraceSendRecv ps where
- TraceSendMsg :: forall ps. AnyMessageAndAgency ps -> TraceSendRecv ps
- TraceRecvMsg :: forall ps. AnyMessageAndAgency ps -> TraceSendRecv ps
data SubscriptionTrace addr
- = SubscriptionTraceConnectStart addr
- | SubscriptionTraceConnectEnd addr ConnectResult
- | Exception e => SubscriptionTraceSocketAllocationException addr e
- | Exception e => SubscriptionTraceConnectException addr e
- | Exception e => SubscriptionTraceApplicationException addr e
- | SubscriptionTraceTryConnectToPeer addr
- | SubscriptionTraceSkippingPeer addr
- | SubscriptionTraceSubscriptionRunning
- | SubscriptionTraceSubscriptionWaiting Int
- | SubscriptionTraceSubscriptionFailed
- | SubscriptionTraceSubscriptionWaitingNewConnection DiffTime
- | SubscriptionTraceStart Int
- | SubscriptionTraceRestart DiffTime Int Int
- | SubscriptionTraceConnectionExist addr
- | SubscriptionTraceUnsupportedRemoteAddr addr
- | SubscriptionTraceMissingLocalAddress
- | SubscriptionTraceAllocateSocket addr
- | SubscriptionTraceCloseSocket addr
data DnsTrace
- = DnsTraceLookupException SomeException
- | DnsTraceLookupAError DNSError
- | DnsTraceLookupAAAAError DNSError
- | DnsTraceLookupIPv6First
- | DnsTraceLookupIPv4First
- | DnsTraceLookupAResult [ SockAddr ]
- | DnsTraceLookupAAAAResult [ SockAddr ]
data ErrorPolicyTrace
- = ErrorPolicySuspendPeer ( Maybe (ConnectionOrApplicationExceptionTrace SomeException )) DiffTime DiffTime
- | ErrorPolicySuspendConsumer ( Maybe (ConnectionOrApplicationExceptionTrace SomeException )) DiffTime
- | ErrorPolicyLocalNodeError (ConnectionOrApplicationExceptionTrace SomeException )
- | ErrorPolicyResumePeer
- | ErrorPolicyKeepSuspended
- | ErrorPolicyResumeConsumer
- | ErrorPolicyResumeProducer
- | ErrorPolicyUnhandledApplicationException SomeException
- | ErrorPolicyUnhandledConnectionException SomeException
- | ErrorPolicyAcceptException IOException
data WithIPList a = WithIPList {
- wilSrc :: LocalAddresses SockAddr
- wilDsts :: [ SockAddr ]
- wilEvent :: a
}
data WithDomainName a = WithDomainName {
- wdnDomain :: Domain
- wdnEvent :: a
}
data WithAddr addr a = WithAddr {
- wiaAddr :: addr
- wiaEvent :: a
}
type HandshakeTr ntnAddr ntnVersion = WithMuxBearer ( ConnectionId ntnAddr) ( TraceSendRecv ( Handshake ntnVersion Term ))
chainSyncMiniProtocolNum :: MiniProtocolNum
blockFetchMiniProtocolNum :: MiniProtocolNum
txSubmissionMiniProtocolNum :: MiniProtocolNum
keepAliveMiniProtocolNum :: MiniProtocolNum

Documentation

nodeToNodeProtocols :: MiniProtocolParameters -> ( ConnectionId addr -> STM m ControlMessage -> NodeToNodeProtocols muxMode bytes m a b) -> NodeToNodeVersion -> OuroborosBundle muxMode addr bytes m a b Source #

Make an OuroborosApplication for the bundle of mini-protocols that make up the overall node-to-node protocol.

This function specifies the wire format protocol numbers.

The application specific protocol numbers start from 2. The MiniProtocolNum 0 is reserved for the Handshake protocol, while MiniProtocolNum 1 is reserved for DeltaQ messages. Handshake protocol is not included in NodeToNodeProtocols as it runs before mux is started but it reusing MuxBearer to send and receive messages. Only when the handshake protocol succeeds, we will know which protocols to run / multiplex.

These are chosen to not overlap with the node to client protocol numbers (and the handshake protocol number). This is not essential for correctness, but is helpful to allow a single shared implementation of tools that can analyse both protocols, e.g. wireshark plugins.

data NodeToNodeProtocols appType bytes m a b Source #

Constructors

NodeToNodeProtocols
Fields chainSyncProtocol :: RunMiniProtocol appType bytes m a b chain-sync mini-protocol blockFetchProtocol :: RunMiniProtocol appType bytes m a b block-fetch mini-protocol txSubmissionProtocol :: RunMiniProtocol appType bytes m a b tx-submission mini-protocol keepAliveProtocol :: RunMiniProtocol appType bytes m a b keep-alive mini-protocol

data MiniProtocolParameters Source #

Constructors

MiniProtocolParameters

Fields

chainSyncPipeliningHighMark :: ! Word32

high threshold for pipelining (we will never exceed that many messages pipelined).
chainSyncPipeliningLowMark :: ! Word32

low threshold: if we hit the chainSyncPipeliningHighMark we will listen for responses until there are at most chainSyncPipeliningLowMark pipelined message

Must be smaller than chainSyncPipeliningHighMark .

Note: chainSyncPipeliningLowMark and chainSyncPipeliningLowMark are passed to pipelineDecisionLowHighMark .
blockFetchPipeliningMax :: ! Word

maximal number of pipelined messages in 'block-fetch' mini-protocol.
txSubmissionMaxUnacked :: ! Word16

maximal number of unacked tx (pipelining is bounded by twice this number)

chainSyncProtocolLimits :: MiniProtocolParameters -> MiniProtocolLimits Source #

blockFetchProtocolLimits :: MiniProtocolParameters -> MiniProtocolLimits Source #

txSubmissionProtocolLimits :: MiniProtocolParameters -> MiniProtocolLimits Source #

keepAliveProtocolLimits :: MiniProtocolParameters -> MiniProtocolLimits Source #

defaultMiniProtocolParameters :: MiniProtocolParameters Source #

data NodeToNodeVersion Source #

Enumeration of node to node protocol versions.

Constructors

NodeToNodeV_7	Changes: new `KeepAlive` codec Enable `CardanoNodeToNodeVersion5` , i.e., Alonzo
NodeToNodeV_8	Changes: Enable block diffusion pipelining in ChainSync and BlockFetch logic.
NodeToNodeV_9	Changes: Enable `CardanoNodeToNodeVersion6` , i.e., Babbage
NodeToNodeV_10	Changes: Enable full duplex connections. NOTE: This is an experimental protocol version, which is not yet released. Until initial P2P version it must be kept as the last version, which allows us to keep it as an experimental version.

Instances

Instances details

Bounded NodeToNodeVersion Source #
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods minBound :: NodeToNodeVersion Source # maxBound :: NodeToNodeVersion Source #
Enum NodeToNodeVersion Source #
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods succ :: NodeToNodeVersion -> NodeToNodeVersion Source # pred :: NodeToNodeVersion -> NodeToNodeVersion Source # toEnum :: Int -> NodeToNodeVersion Source # fromEnum :: NodeToNodeVersion -> Int Source # enumFrom :: NodeToNodeVersion -> [ NodeToNodeVersion ] Source # enumFromThen :: NodeToNodeVersion -> NodeToNodeVersion -> [ NodeToNodeVersion ] Source # enumFromTo :: NodeToNodeVersion -> NodeToNodeVersion -> [ NodeToNodeVersion ] Source # enumFromThenTo :: NodeToNodeVersion -> NodeToNodeVersion -> NodeToNodeVersion -> [ NodeToNodeVersion ] Source #
Eq NodeToNodeVersion Source #
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods (==) :: NodeToNodeVersion -> NodeToNodeVersion -> Bool Source # (/=) :: NodeToNodeVersion -> NodeToNodeVersion -> Bool Source #
Ord NodeToNodeVersion Source #
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods compare :: NodeToNodeVersion -> NodeToNodeVersion -> Ordering Source # (<) :: NodeToNodeVersion -> NodeToNodeVersion -> Bool Source # (<=) :: NodeToNodeVersion -> NodeToNodeVersion -> Bool Source # (>) :: NodeToNodeVersion -> NodeToNodeVersion -> Bool Source # (>=) :: NodeToNodeVersion -> NodeToNodeVersion -> Bool Source # max :: NodeToNodeVersion -> NodeToNodeVersion -> NodeToNodeVersion Source # min :: NodeToNodeVersion -> NodeToNodeVersion -> NodeToNodeVersion Source #
Show NodeToNodeVersion Source #
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods showsPrec :: Int -> NodeToNodeVersion -> ShowS Source # show :: NodeToNodeVersion -> String Source # showList :: [ NodeToNodeVersion ] -> ShowS Source #

data NodeToNodeVersionData Source #

Version data for NodeToNode protocol

Constructors

NodeToNodeVersionData
Fields networkMagic :: ! NetworkMagic diffusionMode :: ! DiffusionMode

Instances

Instances details

Eq NodeToNodeVersionData Source #
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods (==) :: NodeToNodeVersionData -> NodeToNodeVersionData -> Bool Source # (/=) :: NodeToNodeVersionData -> NodeToNodeVersionData -> Bool Source #
Show NodeToNodeVersionData Source #
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods showsPrec :: Int -> NodeToNodeVersionData -> ShowS Source # show :: NodeToNodeVersionData -> String Source # showList :: [ NodeToNodeVersionData ] -> ShowS Source #
Acceptable NodeToNodeVersionData Source #
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods acceptableVersion :: NodeToNodeVersionData -> NodeToNodeVersionData -> Accept NodeToNodeVersionData Source #

data NetworkConnectTracers addr vNumber Source #

Tracer used by connectToNode (and derivatives, like connectTo or 'Ouroboros.Network.NodeToClient.connectTo).

Constructors

NetworkConnectTracers
Fields nctMuxTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) MuxTrace ) low level mux-network tracer, which logs mux sdu (send and received) and other low level multiplexing events. nctHandshakeTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) ( TraceSendRecv ( Handshake vNumber Term ))) handshake protocol tracer; it is important for analysing version negotation mismatches.

nullNetworkConnectTracers :: NetworkConnectTracers addr vNumber Source #

connectTo :: Snocket IO Socket SockAddr -> NetworkConnectTracers SockAddr NodeToNodeVersion -> Versions NodeToNodeVersion NodeToNodeVersionData ( OuroborosApplication InitiatorMode SockAddr ByteString IO a b) -> Maybe SockAddr -> SockAddr -> IO () Source #

A specialised version of connectToNode .

data NetworkServerTracers addr vNumber Source #

Tracers required by a server which handles inbound connections.

Constructors

NetworkServerTracers

Fields

nstMuxTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) MuxTrace )

low level mux-network tracer, which logs mux sdu (send and received) and other low level multiplexing events.
nstHandshakeTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) ( TraceSendRecv ( Handshake vNumber Term )))

handshake protocol tracer; it is important for analysing version negotation mismatches.
nstErrorPolicyTracer :: Tracer IO ( WithAddr addr ErrorPolicyTrace )

error policy tracer; must not be nullTracer , otherwise all the exceptions which are not matched by any error policy will be caught and not logged or rethrown.
nstAcceptPolicyTracer :: Tracer IO AcceptConnectionsPolicyTrace

tracing rate limiting of accepting connections.

nullNetworkServerTracers :: NetworkServerTracers addr vNumber Source #

data NetworkMutableState addr Source #

Mutable state maintained by the network component.

Constructors

NetworkMutableState
Fields nmsConnectionTable :: ConnectionTable IO addr `ConnectionTable` which maintains information about current upstream and downstream connections. nmsPeerStates :: StrictTVar IO ( PeerStates IO addr) `PeerStates` which maintains state of each downstream / upstream peer that errored, misbehaved or was not interesting to us.

data AcceptedConnectionsLimit Source #

Policy which governs how to limit the number of accepted connections.

Constructors

AcceptedConnectionsLimit

Fields

acceptedConnectionsHardLimit :: ! Word32

Hard limit of accepted connections.
acceptedConnectionsSoftLimit :: ! Word32

Soft limit of accepted connections. If we are above this threshold, we will start rate limiting.
acceptedConnectionsDelay :: ! DiffTime

Max delay for limiting accepted connections. We use linear regression starting from 0 at the soft limit up to acceptedConnectionDelay at the hard limit.

Instances

Instances details

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

newNetworkMutableState :: IO ( NetworkMutableState addr) Source #

newNetworkMutableStateSTM :: STM ( NetworkMutableState addr) Source #

cleanNetworkMutableState :: NetworkMutableState addr -> IO () Source #

Clean PeerStates within NetworkMutableState every 200s

withServer :: SocketSnocket -> NetworkServerTracers SockAddr NodeToNodeVersion -> NetworkMutableState SockAddr -> AcceptedConnectionsLimit -> Socket -> Versions NodeToNodeVersion NodeToNodeVersionData ( OuroborosApplication ResponderMode SockAddr ByteString IO a b) -> ErrorPolicies -> IO Void Source #

A specialised version of withServerNode . It forks a thread which runs an accept loop (server thread):

when the server thread throws an exception the main thread rethrows it (by wait )
when an async exception is thrown to kill the main thread the server thread will be cancelled as well (by withAsync )

P2P Governor

data DomainAccessPoint Source #

A product of a Domain and PortNumber . After resolving the domain we will use the PortNumber to form SockAddr .

Constructors

DomainAccessPoint
Fields dapDomain :: ! Domain dapPortNumber :: ! PortNumber

Instances

Instances details

Eq DomainAccessPoint Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods (==) :: DomainAccessPoint -> DomainAccessPoint -> Bool Source # (/=) :: DomainAccessPoint -> DomainAccessPoint -> Bool Source #
Ord DomainAccessPoint Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods compare :: DomainAccessPoint -> DomainAccessPoint -> Ordering Source # (<) :: DomainAccessPoint -> DomainAccessPoint -> Bool Source # (<=) :: DomainAccessPoint -> DomainAccessPoint -> Bool Source # (>) :: DomainAccessPoint -> DomainAccessPoint -> Bool Source # (>=) :: DomainAccessPoint -> DomainAccessPoint -> Bool Source # max :: DomainAccessPoint -> DomainAccessPoint -> DomainAccessPoint Source # min :: DomainAccessPoint -> DomainAccessPoint -> DomainAccessPoint Source #
Show DomainAccessPoint Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods showsPrec :: Int -> DomainAccessPoint -> ShowS Source # show :: DomainAccessPoint -> String Source # showList :: [ DomainAccessPoint ] -> ShowS Source #
ToJSON DomainAccessPoint Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods toJSON :: DomainAccessPoint -> Value Source # toEncoding :: DomainAccessPoint -> Encoding Source # toJSONList :: [ DomainAccessPoint ] -> Value Source # toEncodingList :: [ DomainAccessPoint ] -> Encoding Source #
FromJSON DomainAccessPoint Source #
Instance details Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint Methods parseJSON :: Value -> Parser DomainAccessPoint Source # parseJSONList :: Value -> Parser [ DomainAccessPoint ] Source #

data PeerAdvertise Source #

Should this peer be advertised to other peers asking for known peers? For certain peers specified by configuration it would be an appropriate policy to keep them private.

Constructors

DoNotAdvertisePeer
DoAdvertisePeer

Instances

Instances details

Eq PeerAdvertise Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Types Methods (==) :: PeerAdvertise -> PeerAdvertise -> Bool Source # (/=) :: PeerAdvertise -> PeerAdvertise -> Bool Source #
Ord PeerAdvertise Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Types Methods compare :: PeerAdvertise -> PeerAdvertise -> Ordering Source # (<) :: PeerAdvertise -> PeerAdvertise -> Bool Source # (<=) :: PeerAdvertise -> PeerAdvertise -> Bool Source # (>) :: PeerAdvertise -> PeerAdvertise -> Bool Source # (>=) :: PeerAdvertise -> PeerAdvertise -> Bool Source # max :: PeerAdvertise -> PeerAdvertise -> PeerAdvertise Source # min :: PeerAdvertise -> PeerAdvertise -> PeerAdvertise Source #
Show PeerAdvertise Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Types Methods showsPrec :: Int -> PeerAdvertise -> ShowS Source # show :: PeerAdvertise -> String Source # showList :: [ PeerAdvertise ] -> ShowS Source #
Generic PeerAdvertise Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Types Associated Types type Rep PeerAdvertise :: Type -> Type Source # Methods from :: PeerAdvertise -> Rep PeerAdvertise x Source # to :: Rep PeerAdvertise x -> PeerAdvertise Source #
ToJSON PeerAdvertise Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Types Methods toJSON :: PeerAdvertise -> Value Source # toEncoding :: PeerAdvertise -> Encoding Source # toJSONList :: [ PeerAdvertise ] -> Value Source # toEncodingList :: [ PeerAdvertise ] -> Encoding Source #
FromJSON PeerAdvertise Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Types Methods parseJSON :: Value -> Parser PeerAdvertise Source # parseJSONList :: Value -> Parser [ PeerAdvertise ] Source #
type Rep PeerAdvertise Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Types type Rep PeerAdvertise = D1 (' MetaData "PeerAdvertise" "Ouroboros.Network.PeerSelection.Types" "ouroboros-network-0.1.0.1-2UgqzRSdBh49QYumtriFSI" ' False ) ( C1 (' MetaCons "DoNotAdvertisePeer" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "DoAdvertisePeer" ' PrefixI ' False ) ( U1 :: Type -> Type ))

data PeerSelectionTargets Source #

Adjustable targets for the peer selection mechanism.

These are used by the peer selection governor as targets. They are used by the peer churn governor loop as knobs to adjust, to influence the peer selection governor.

The known , established and active peer targets are targets both from below and from above: the governor will attempt to grow or shrink the sets to hit these targets.

Unlike the other targets, the root peer target is "one sided", it is only a target from below. The governor does not try to shrink the root set to hit it, it simply stops looking for more.

There is also an implicit target that enough local root peers are selected as active. This comes from the configuration for local roots, and is not an independently adjustable target.

Constructors

PeerSelectionTargets
Fields targetNumberOfRootPeers :: ! Int targetNumberOfKnownPeers :: ! Int targetNumberOfEstablishedPeers :: ! Int targetNumberOfActivePeers :: ! Int

Instances

Instances details

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

Subscription Workers

IP subscription worker

data IPSubscriptionTarget Source #

Constructors

IPSubscriptionTarget
Fields ispIps :: ![ SockAddr ] List of destinations to possibly connect to ispValency :: ! Int Number of parallel connections to keep actice.

Instances

Instances details

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

type NetworkIPSubscriptionTracers addr vNumber = NetworkSubscriptionTracers WithIPList addr vNumber Source #

data NetworkSubscriptionTracers withIPList addr vNumber Source #

IP subscription tracers.

Constructors

NetworkSubscriptionTracers

Fields

nsMuxTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) MuxTrace )

low level mux-network tracer, which logs mux sdu (send and received) and other low level multiplexing events.
nsHandshakeTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) ( TraceSendRecv ( Handshake vNumber Term )))

handshake protocol tracer; it is important for analysing version negotation mismatches.
nsErrorPolicyTracer :: Tracer IO ( WithAddr addr ErrorPolicyTrace )

error policy tracer; must not be nullTracer , otherwise all the exceptions which are not matched by any error policy will be caught and not logged or rethrown.
nsSubscriptionTracer :: Tracer IO (withIPList ( SubscriptionTrace addr))

subscription tracers; it is infrequent it should not be nullTracer by default.

nullNetworkSubscriptionTracers :: NetworkSubscriptionTracers withIPList addr vNumber Source #

data SubscriptionParams a target Source #

ipSubscriptionWorker and dnsSubscriptionWorker parameters

Constructors

SubscriptionParams
Fields spLocalAddresses :: LocalAddresses SockAddr spConnectionAttemptDelay :: SockAddr -> Maybe DiffTime should return expected delay for the given address spErrorPolicies :: ErrorPolicies spSubscriptionTarget :: target

type IPSubscriptionParams a = SubscriptionParams a IPSubscriptionTarget Source #

ipSubscriptionWorker :: forall mode x y. HasInitiator mode ~ True => SocketSnocket -> NetworkIPSubscriptionTracers SockAddr NodeToNodeVersion -> NetworkMutableState SockAddr -> IPSubscriptionParams () -> Versions NodeToNodeVersion NodeToNodeVersionData ( OuroborosApplication mode SockAddr ByteString IO x y) -> IO Void Source #

ipSubscriptionWorker which starts given application versions on each established connection.

DNS subscription worker

data DnsSubscriptionTarget Source #

Constructors

DnsSubscriptionTarget
Fields dstDomain :: ! Domain dstPort :: ! PortNumber dstValency :: ! Int

Instances

Instances details

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

type DnsSubscriptionParams a = SubscriptionParams a DnsSubscriptionTarget Source #

data NetworkDNSSubscriptionTracers vNumber addr Source #

DNS subscription tracers.

Constructors

NetworkDNSSubscriptionTracers

Fields

ndstMuxTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) MuxTrace )

low level mux-network tracer, which logs mux sdu (send and received) and other low level multiplexing events.
ndstHandshakeTracer :: Tracer IO ( WithMuxBearer ( ConnectionId addr) ( TraceSendRecv ( Handshake vNumber Term )))

handshake protocol tracer; it is important for analysing version negotation mismatches.
ndstErrorPolicyTracer :: Tracer IO ( WithAddr addr ErrorPolicyTrace )

error policy tracer; must not be nullTracer , otherwise all the exceptions which are not matched by any error policy will be caught and not logged or rethrown.
ndstSubscriptionTracer :: Tracer IO ( WithDomainName ( SubscriptionTrace addr))

subscription tracer; it is infrequent it should not be nullTracer by default.
ndstDnsTracer :: Tracer IO ( WithDomainName DnsTrace )

dns resolver tracer; it is infrequent it should not be nullTracer by default.

nullNetworkDNSSubscriptionTracers :: NetworkDNSSubscriptionTracers vNumber peerid Source #

dnsSubscriptionWorker :: forall mode x y. HasInitiator mode ~ True => SocketSnocket -> NetworkDNSSubscriptionTracers NodeToNodeVersion SockAddr -> NetworkMutableState SockAddr -> DnsSubscriptionParams () -> Versions NodeToNodeVersion NodeToNodeVersionData ( OuroborosApplication mode SockAddr ByteString IO x y) -> IO Void Source #

dnsSubscriptionWorker which starts given application versions on each established connection.

Versions

newtype Versions vNum vData r Source #

The version map supported by the local agent keyed on the version identifier.

Each Version contains a function which takes negotiated version data and returns negotiated application (the r type variable).

If one needs to combine multiple versions the simplest way is to use one of the combinators: foldMapVersions , combineVersions or the Semigroup instance directly:

fold $ (simpleSingletonVersions ...)
      :| [ (simpleSingletonVersions ...)
         , (simpleSingletonVersions ...)
         , ...
         ]

Constructors

Versions
Fields getVersions :: Map vNum ( Version vData r)

Instances

Instances details

Functor ( Versions vNum extra)
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Version Methods fmap :: (a -> b) -> Versions vNum extra a -> Versions vNum extra b Source # (<$) :: a -> Versions vNum extra b -> Versions vNum extra a Source #
Ord vNum => Semigroup ( Versions vNum vData r)
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Version Methods (<>) :: Versions vNum vData r -> Versions vNum vData r -> Versions vNum vData r Source # sconcat :: NonEmpty ( Versions vNum vData r) -> Versions vNum vData r Source # stimes :: Integral b => b -> Versions vNum vData r -> Versions vNum vData r Source #

data DiffusionMode Source #

The flag which indicates wheather the node runs only initiator or both initiator or responder node. It does not however specify weather the node is using duplex connections, this is implicit see NodeToNodeV_4

Constructors

InitiatorOnlyDiffusionMode
InitiatorAndResponderDiffusionMode

Instances

Instances details

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

simpleSingletonVersions :: vNum -> vData -> r -> Versions vNum vData r Source #

Singleton smart constructor for Versions .

foldMapVersions :: ( Ord vNum, Foldable f, HasCallStack ) => (x -> Versions vNum extra r) -> f x -> Versions vNum extra r Source #

Useful for folding multiple Versions .

A foldMap restricted to the Versions Semigroup .

PRECONDITION: f x is non-empty.

combineVersions :: ( Ord vNum, Foldable f, HasCallStack ) => f ( Versions vNum extra r) -> Versions vNum extra r Source #

Codecs

nodeToNodeHandshakeCodec :: MonadST m => Codec ( Handshake NodeToNodeVersion Term ) DeserialiseFailure m ByteString Source #

Handshake codec for the node-to-node protocol suite.

nodeToNodeVersionCodec :: CodecCBORTerm ( Text , Maybe Int ) NodeToNodeVersion Source #

nodeToNodeCodecCBORTerm :: NodeToNodeVersion -> CodecCBORTerm Text NodeToNodeVersionData Source #

Re-exports

data ConnectionId addr Source #

Connection is identified by local and remote address.

TODO: the type variable which this data type fills in is called peerid . We should renamed to connectionId .

Constructors

ConnectionId
Fields localAddress :: !addr remoteAddress :: !addr

Instances

Instances details

Eq addr => Eq ( ConnectionId addr)
Instance details Defined in Ouroboros.Network.ConnectionId Methods (==) :: ConnectionId addr -> ConnectionId addr -> Bool Source # (/=) :: ConnectionId addr -> ConnectionId addr -> Bool Source #
Ord addr => Ord ( ConnectionId addr)
Instance details Defined in Ouroboros.Network.ConnectionId Methods compare :: ConnectionId addr -> ConnectionId addr -> Ordering Source # (<) :: ConnectionId addr -> ConnectionId addr -> Bool Source # (<=) :: ConnectionId addr -> ConnectionId addr -> Bool Source # (>) :: ConnectionId addr -> ConnectionId addr -> Bool Source # (>=) :: ConnectionId addr -> ConnectionId addr -> Bool Source # max :: ConnectionId addr -> ConnectionId addr -> ConnectionId addr Source # min :: ConnectionId addr -> ConnectionId addr -> ConnectionId addr Source #
Show addr => Show ( ConnectionId addr)
Instance details Defined in Ouroboros.Network.ConnectionId Methods showsPrec :: Int -> ConnectionId addr -> ShowS Source # show :: ConnectionId addr -> String Source # showList :: [ ConnectionId addr] -> ShowS Source #
Generic ( ConnectionId addr)
Instance details Defined in Ouroboros.Network.ConnectionId Associated Types type Rep ( ConnectionId addr) :: Type -> Type Source # Methods from :: ConnectionId addr -> Rep ( ConnectionId addr) x Source # to :: Rep ( ConnectionId addr) x -> ConnectionId addr Source #
Hashable a => Hashable ( ConnectionId a)
Instance details Defined in Ouroboros.Network.ConnectionId Methods hashWithSalt :: Int -> ConnectionId a -> Int Source # hash :: ConnectionId a -> Int Source #
Typeable addr => NoThunks ( ConnectionId addr)
Instance details Defined in Ouroboros.Network.ConnectionId Methods noThunks :: Context -> ConnectionId addr -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> ConnectionId addr -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( ConnectionId addr) -> String Source #
type Rep ( ConnectionId addr)
Instance details Defined in Ouroboros.Network.ConnectionId type Rep ( ConnectionId addr) = D1 (' MetaData "ConnectionId" "Ouroboros.Network.ConnectionId" "ouroboros-network-framework-0.1.0.1-8Cos8Lgj9CwATl9eblNk02" ' False ) ( C1 (' MetaCons "ConnectionId" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "localAddress") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 addr) :*: S1 (' MetaSel (' Just "remoteAddress") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 addr)))

type RemoteAddress = SockAddr Source #

type RemoteConnectionId = ConnectionId RemoteAddress Source #

data ProtocolLimitFailure Source #

Instances

Instances details

Show ProtocolLimitFailure
Instance details Defined in Ouroboros.Network.Driver.Limits Methods showsPrec :: Int -> ProtocolLimitFailure -> ShowS Source # show :: ProtocolLimitFailure -> String Source # showList :: [ ProtocolLimitFailure ] -> ShowS Source #
Exception ProtocolLimitFailure
Instance details Defined in Ouroboros.Network.Driver.Limits Methods toException :: ProtocolLimitFailure -> SomeException Source # fromException :: SomeException -> Maybe ProtocolLimitFailure Source # displayException :: ProtocolLimitFailure -> String Source #

data Handshake (vNumber :: k) (vParams :: k1) Source #

The handshake mini-protocol is used initially to agree the version and associated parameters of the protocol to use for all subsequent communication.

Instances

Instances details

ShowProxy ( Handshake vNumber vParams :: Type )
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type Methods showProxy :: Proxy ( Handshake vNumber vParams) -> String Source #
Show ( ClientHasAgency st)
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type Methods showsPrec :: Int -> ClientHasAgency st -> ShowS Source # show :: ClientHasAgency st -> String Source # showList :: [ ClientHasAgency st] -> ShowS Source #
Show ( ServerHasAgency st)
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type Methods showsPrec :: Int -> ServerHasAgency st -> ShowS Source # show :: ServerHasAgency st -> String Source # showList :: [ ServerHasAgency st] -> ShowS Source #
( Show vNumber, Show vParams) => Show ( Message ( Handshake vNumber vParams) from to)
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type Methods showsPrec :: Int -> Message ( Handshake vNumber vParams) from to -> ShowS Source # show :: Message ( Handshake vNumber vParams) from to -> String Source # showList :: [ Message ( Handshake vNumber vParams) from to] -> ShowS Source #
Protocol ( Handshake vNumber vParams)
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type Associated Types data Message ( Handshake vNumber vParams) st st' Source # data ClientHasAgency st Source # data ServerHasAgency st Source # data NobodyHasAgency st Source # Methods exclusionLemma_ClientAndServerHaveAgency :: forall (st :: Handshake vNumber vParams). ClientHasAgency st -> ServerHasAgency st -> Void Source # exclusionLemma_NobodyAndClientHaveAgency :: forall (st :: Handshake vNumber vParams). NobodyHasAgency st -> ClientHasAgency st -> Void Source # exclusionLemma_NobodyAndServerHaveAgency :: forall (st :: Handshake vNumber vParams). NobodyHasAgency st -> ServerHasAgency st -> Void Source #
data Message ( Handshake vNumber vParams) (from :: Handshake vNumber vParams) (to :: Handshake vNumber vParams)
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type data Message ( Handshake vNumber vParams) (from :: Handshake vNumber vParams) (to :: Handshake vNumber vParams) where MsgProposeVersions :: forall vNumber1 vParams1. Map vNumber1 vParams1 -> Message ( Handshake vNumber1 vParams1) (' StPropose :: Handshake vNumber1 vParams1) (' StConfirm :: Handshake vNumber1 vParams1) MsgReplyVersions :: forall vNumber1 vParams1. Map vNumber1 vParams1 -> Message ( Handshake vNumber1 vParams1) (' StConfirm :: Handshake vNumber1 vParams1) (' StDone :: Handshake vNumber1 vParams1) MsgAcceptVersion :: forall vNumber1 vParams1. vNumber1 -> vParams1 -> Message ( Handshake vNumber1 vParams1) (' StConfirm :: Handshake vNumber1 vParams1) (' StDone :: Handshake vNumber1 vParams1) MsgRefuse :: forall k1 vNumber1 (vParams :: k1). RefuseReason vNumber1 -> Message ( Handshake vNumber1 vParams) (' StConfirm :: Handshake vNumber1 vParams) (' StDone :: Handshake vNumber1 vParams)
data ClientHasAgency (st :: Handshake vNumber vParams)
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type data ClientHasAgency (st :: Handshake vNumber vParams) where TokPropose :: forall k k1 (vNumber :: k) (vParams :: k1). ClientHasAgency (' StPropose :: Handshake vNumber vParams)
data ServerHasAgency (st :: Handshake vNumber vParams)
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type data ServerHasAgency (st :: Handshake vNumber vParams) where TokConfirm :: forall k k1 (vNumber :: k) (vParams :: k1). ServerHasAgency (' StConfirm :: Handshake vNumber vParams)
data NobodyHasAgency (st :: Handshake vNumber vParams)
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type data NobodyHasAgency (st :: Handshake vNumber vParams) where TokDone :: forall k k1 (vNumber :: k) (vParams :: k1). NobodyHasAgency (' StDone :: Handshake vNumber vParams)

data LocalAddresses addr Source #

Constructors

LocalAddresses
Fields laIpv4 :: Maybe addr Local IPv4 address to use, Nothing indicates don't use IPv4 laIpv6 :: Maybe addr Local IPv6 address to use, Nothing indicates don't use IPv6 laUnix :: Maybe addr Local Unix address to use, Nothing indicates don't use Unix sockets

Instances

Instances details

Eq addr => Eq ( LocalAddresses addr)
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods (==) :: LocalAddresses addr -> LocalAddresses addr -> Bool Source # (/=) :: LocalAddresses addr -> LocalAddresses addr -> Bool Source #
Show addr => Show ( LocalAddresses addr)
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods showsPrec :: Int -> LocalAddresses addr -> ShowS Source # show :: LocalAddresses addr -> String Source # showList :: [ LocalAddresses addr] -> ShowS Source #
Semigroup ( LocalAddresses addr)
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods (<>) :: LocalAddresses addr -> LocalAddresses addr -> LocalAddresses addr Source # sconcat :: NonEmpty ( LocalAddresses addr) -> LocalAddresses addr Source # stimes :: Integral b => b -> LocalAddresses addr -> LocalAddresses addr Source #

data Socket Source #

Basic type for a socket.

Instances

Instances details

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

isPipeliningEnabled :: NodeToNodeVersion -> Bool Source #

Check whether a version enabling diffusion pipelining has been negotiated.

Error Policies and Peer state

data ErrorPolicies Source #

List of error policies for exception handling and a policy for handing application return values.

Constructors

ErrorPolicies
Fields epAppErrorPolicies :: [ ErrorPolicy ] Application Error Policies epConErrorPolicies :: [ ErrorPolicy ] `connect` Error Policies

Instances

Instances details

Semigroup ErrorPolicies
Instance details Defined in Ouroboros.Network.ErrorPolicy Methods (<>) :: ErrorPolicies -> ErrorPolicies -> ErrorPolicies Source # sconcat :: NonEmpty ErrorPolicies -> ErrorPolicies Source # stimes :: Integral b => b -> ErrorPolicies -> ErrorPolicies Source #

remoteNetworkErrorPolicy :: ErrorPolicies Source #

A minimal error policy for remote peers, which only handles exceptions raised by `ouroboros-network`.

localNetworkErrorPolicy :: ErrorPolicies Source #

Error policy for local clients. This is equivalent to nullErrorPolicies , but explicit in the errors which can be caught.

We are very permissive here, and very strict in the networkErrorPolicy . After any failure the client will be killed and not penalised by this policy. This allows to restart the local client without a delay.

nullErrorPolicies :: ErrorPolicies Source #

data ErrorPolicy where Source #

Constructors

ErrorPolicy
Fields :: forall e. Exception e => (e -> Maybe ( SuspendDecision DiffTime )) `Nothing` means no decision. It is equivalent to not having the policy at all. In `evalErrorPolicies` this will fall-through and match against the remaining policies. -> ErrorPolicy

Instances

Instances details

Show ErrorPolicy
Instance details Defined in Ouroboros.Network.ErrorPolicy Methods showsPrec :: Int -> ErrorPolicy -> ShowS Source # show :: ErrorPolicy -> String Source # showList :: [ ErrorPolicy ] -> ShowS Source #

data SuspendDecision t Source #

Semigroup of commands which acts on PeerState . The t variable might be initiated to DiffTime or Time m .

This semigroup allows to either suspend both consumer and producer or just the consumer part.

Constructors

SuspendPeer !t !t	peer is suspend; The first `t` is the time until which a local producer is suspended, the second one is the time until which a local consumer is suspended.
SuspendConsumer !t	suspend local consumer / initiator side until `t` (this mean we are not allowing to communicate with the producer / responder of a remote peer).
Throw	throw an error from the main thread.

Instances

Instances details

Functor SuspendDecision
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods fmap :: (a -> b) -> SuspendDecision a -> SuspendDecision b Source # (<$) :: a -> SuspendDecision b -> SuspendDecision a Source #
Eq t => Eq ( SuspendDecision t)
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods (==) :: SuspendDecision t -> SuspendDecision t -> Bool Source # (/=) :: SuspendDecision t -> SuspendDecision t -> Bool Source #
Ord t => Ord ( SuspendDecision t)
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods compare :: SuspendDecision t -> SuspendDecision t -> Ordering Source # (<) :: SuspendDecision t -> SuspendDecision t -> Bool Source # (<=) :: SuspendDecision t -> SuspendDecision t -> Bool Source # (>) :: SuspendDecision t -> SuspendDecision t -> Bool Source # (>=) :: SuspendDecision t -> SuspendDecision t -> Bool Source # max :: SuspendDecision t -> SuspendDecision t -> SuspendDecision t Source # min :: SuspendDecision t -> SuspendDecision t -> SuspendDecision t Source #
Show t => Show ( SuspendDecision t)
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods showsPrec :: Int -> SuspendDecision t -> ShowS Source # show :: SuspendDecision t -> String Source # showList :: [ SuspendDecision t] -> ShowS Source #
Ord t => Semigroup ( SuspendDecision t)	The semigroup instance. Note that composing `SuspendPeer` with `SuspendConsumer` gives `SuspendPeer` . `SuspendPeer` and `SuspendConsumer` form a sub-semigroup.
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods (<>) :: SuspendDecision t -> SuspendDecision t -> SuspendDecision t Source # sconcat :: NonEmpty ( SuspendDecision t) -> SuspendDecision t Source # stimes :: Integral b => b -> SuspendDecision t -> SuspendDecision t Source #
SAct ( SuspendDecision Time ) ( Maybe ( PeerState m))	Action of `SuspendDecision` on `Maybe PeerState` . We use this action together with `alter` function. Note: `SuspendDecision` does not act on `PeerState` , only the sub-semigroup generated by `SuspendConsumer` and `SuspendPeer` does.
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods (<\|) :: Maybe ( PeerState m) -> SuspendDecision Time -> Maybe ( PeerState m) Source #

Traces

data AcceptConnectionsPolicyTrace Source #

Trace for the AcceptConnectionsLimit policy.

Constructors

ServerTraceAcceptConnectionRateLimiting DiffTime Int
ServerTraceAcceptConnectionHardLimit Word32
ServerTraceAcceptConnectionResume Int

Instances

Instances details

Eq AcceptConnectionsPolicyTrace
Instance details Defined in Ouroboros.Network.Server.RateLimiting Methods (==) :: AcceptConnectionsPolicyTrace -> AcceptConnectionsPolicyTrace -> Bool Source # (/=) :: AcceptConnectionsPolicyTrace -> AcceptConnectionsPolicyTrace -> Bool Source #
Ord AcceptConnectionsPolicyTrace
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
Instance details Defined in Ouroboros.Network.Server.RateLimiting Methods showsPrec :: Int -> AcceptConnectionsPolicyTrace -> ShowS Source # show :: AcceptConnectionsPolicyTrace -> String Source # showList :: [ AcceptConnectionsPolicyTrace ] -> ShowS Source #

data TraceSendRecv ps where Source #

Structured Tracer output for runPeer and derivitives.

Constructors

TraceSendMsg :: forall ps. AnyMessageAndAgency ps -> TraceSendRecv ps
TraceRecvMsg :: forall ps. AnyMessageAndAgency ps -> TraceSendRecv ps

Instances

Instances details

Show ( AnyMessageAndAgency ps) => Show ( TraceSendRecv ps)
Instance details Defined in Ouroboros.Network.Driver.Simple Methods showsPrec :: Int -> TraceSendRecv ps -> ShowS Source # show :: TraceSendRecv ps -> String Source # showList :: [ TraceSendRecv ps] -> ShowS Source #

data SubscriptionTrace addr Source #

Constructors

SubscriptionTraceConnectStart addr
SubscriptionTraceConnectEnd addr ConnectResult
Exception e => SubscriptionTraceSocketAllocationException addr e
Exception e => SubscriptionTraceConnectException addr e
Exception e => SubscriptionTraceApplicationException addr e
SubscriptionTraceTryConnectToPeer addr
SubscriptionTraceSkippingPeer addr
SubscriptionTraceSubscriptionRunning
SubscriptionTraceSubscriptionWaiting Int
SubscriptionTraceSubscriptionFailed
SubscriptionTraceSubscriptionWaitingNewConnection DiffTime
SubscriptionTraceStart Int
SubscriptionTraceRestart DiffTime Int Int
SubscriptionTraceConnectionExist addr
SubscriptionTraceUnsupportedRemoteAddr addr
SubscriptionTraceMissingLocalAddress
SubscriptionTraceAllocateSocket addr
SubscriptionTraceCloseSocket addr

Instances

Instances details

Show addr => Show ( SubscriptionTrace addr)
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods showsPrec :: Int -> SubscriptionTrace addr -> ShowS Source # show :: SubscriptionTrace addr -> String Source # showList :: [ SubscriptionTrace addr] -> ShowS Source #

data DnsTrace Source #

Constructors

DnsTraceLookupException SomeException
DnsTraceLookupAError DNSError
DnsTraceLookupAAAAError DNSError
DnsTraceLookupIPv6First
DnsTraceLookupIPv4First
DnsTraceLookupAResult [ SockAddr ]
DnsTraceLookupAAAAResult [ SockAddr ]

Instances

Instances details

Show DnsTrace
Instance details Defined in Ouroboros.Network.Subscription.Dns Methods showsPrec :: Int -> DnsTrace -> ShowS Source # show :: DnsTrace -> String Source # showList :: [ DnsTrace ] -> ShowS Source #

data ErrorPolicyTrace Source #

Trace data for error policies

Constructors

ErrorPolicySuspendPeer ( Maybe (ConnectionOrApplicationExceptionTrace SomeException )) DiffTime DiffTime	suspending peer with a given exception until
ErrorPolicySuspendConsumer ( Maybe (ConnectionOrApplicationExceptionTrace SomeException )) DiffTime	suspending consumer until
ErrorPolicyLocalNodeError (ConnectionOrApplicationExceptionTrace SomeException )	caught a local exception
ErrorPolicyResumePeer	resume a peer (both consumer and producer)
ErrorPolicyKeepSuspended	consumer was suspended until producer will resume
ErrorPolicyResumeConsumer	resume consumer
ErrorPolicyResumeProducer	resume producer
ErrorPolicyUnhandledApplicationException SomeException	an application throwed an exception, which was not handled by any `ErrorPolicy` .
ErrorPolicyUnhandledConnectionException SomeException	`connect` throwed an exception, which was not handled by any `ErrorPolicy` .
ErrorPolicyAcceptException IOException	`accept` throwed an exception

Instances

Instances details

Show ErrorPolicyTrace
Instance details Defined in Ouroboros.Network.ErrorPolicy Methods showsPrec :: Int -> ErrorPolicyTrace -> ShowS Source # show :: ErrorPolicyTrace -> String Source # showList :: [ ErrorPolicyTrace ] -> ShowS Source #

data WithIPList a Source #

Constructors

WithIPList
Fields wilSrc :: LocalAddresses SockAddr wilDsts :: [ SockAddr ] wilEvent :: a

Instances

Instances details

Show a => Show ( WithIPList a)
Instance details Defined in Ouroboros.Network.Subscription.Ip Methods showsPrec :: Int -> WithIPList a -> ShowS Source # show :: WithIPList a -> String Source # showList :: [ WithIPList a] -> ShowS Source #

data WithDomainName a Source #

Constructors

WithDomainName
Fields wdnDomain :: Domain wdnEvent :: a

Instances

Instances details

Show a => Show ( WithDomainName a)
Instance details Defined in Ouroboros.Network.Subscription.Dns Methods showsPrec :: Int -> WithDomainName a -> ShowS Source # show :: WithDomainName a -> String Source # showList :: [ WithDomainName a] -> ShowS Source #

data WithAddr addr a Source #

Constructors

WithAddr
Fields wiaAddr :: addr wiaEvent :: a

Instances

Instances details

( Show addr, Show a) => Show ( WithAddr addr a)
Instance details Defined in Ouroboros.Network.ErrorPolicy Methods showsPrec :: Int -> WithAddr addr a -> ShowS Source # show :: WithAddr addr a -> String Source # showList :: [ WithAddr addr a] -> ShowS Source #

type HandshakeTr ntnAddr ntnVersion = WithMuxBearer ( ConnectionId ntnAddr) ( TraceSendRecv ( Handshake ntnVersion Term )) Source #

For Consensus ThreadNet Tests

chainSyncMiniProtocolNum :: MiniProtocolNum Source #

blockFetchMiniProtocolNum :: MiniProtocolNum Source #

txSubmissionMiniProtocolNum :: MiniProtocolNum Source #

keepAliveMiniProtocolNum :: MiniProtocolNum Source #