Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.NodeToNode

Contents

P2P Governor
Subscription Workers
Re-exports
For Consensus ThreadNet Tests
Orphan instances

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 -> NodeToNodeProtocols muxMode initiatorCtx responderCtx bytes m a b -> NodeToNodeVersion -> PeerSharing -> OuroborosBundle muxMode initiatorCtx responderCtx bytes m a b
data NodeToNodeProtocols appType initiatorCtx responderCtx bytes m a b = NodeToNodeProtocols {
- chainSyncProtocol :: RunMiniProtocol appType initiatorCtx responderCtx bytes m a b
- blockFetchProtocol :: RunMiniProtocol appType initiatorCtx responderCtx bytes m a b
- txSubmissionProtocol :: RunMiniProtocol appType initiatorCtx responderCtx bytes m a b
- keepAliveProtocol :: RunMiniProtocol appType initiatorCtx responderCtx bytes m a b
- peerSharingProtocol :: RunMiniProtocol appType initiatorCtx responderCtx bytes m a b
}
type NodeToNodeProtocolsWithExpandedCtx appType ntnAddr bytes m a b = NodeToNodeProtocols appType (ExpandedInitiatorContext ntnAddr m) (ResponderContext ntnAddr) bytes m a b
type NodeToNodeProtocolsWithMinimalCtx appType ntnAddr bytes m a b = NodeToNodeProtocols appType (MinimalInitiatorContext ntnAddr) (ResponderContext ntnAddr) 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
- | NodeToNodeV_11
- | NodeToNodeV_12
- | NodeToNodeV_13
data NodeToNodeVersionData = NodeToNodeVersionData {
- networkMagic :: !NetworkMagic
- diffusionMode :: !DiffusionMode
- peerSharing :: !PeerSharing
- query :: !Bool
}
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 (OuroborosApplicationWithMinimalCtx 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 (OuroborosApplicationWithMinimalCtx ResponderMode SockAddr ByteString IO a b) -> ErrorPolicies -> IO Void
data PeerAdvertise
- = DoNotAdvertisePeer
- | DoAdvertisePeer
data PeerSelectionTargets = PeerSelectionTargets {
- targetNumberOfRootPeers :: !Int
- targetNumberOfKnownPeers :: !Int
- targetNumberOfEstablishedPeers :: !Int
- targetNumberOfActivePeers :: !Int
- targetNumberOfKnownBigLedgerPeers :: !Int
- targetNumberOfEstablishedBigLedgerPeers :: !Int
- targetNumberOfActiveBigLedgerPeers :: !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 (OuroborosApplicationWithMinimalCtx 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 (OuroborosApplicationWithMinimalCtx 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 :: forall (m :: Type -> Type). MonadST m => Codec (Handshake NodeToNodeVersion Term) DeserialiseFailure m ByteString
nodeToNodeVersionCodec :: CodecCBORTerm (Text, Maybe Int) NodeToNodeVersion
nodeToNodeCodecCBORTerm :: NodeToNodeVersion -> CodecCBORTerm Text NodeToNodeVersionData
data ExpandedInitiatorContext addr (m :: Type -> Type) = ExpandedInitiatorContext {
- eicConnectionId :: !(ConnectionId addr)
- eicControlMessage :: !(ControlMessageSTM m)
- eicIsBigLedgerPeer :: !IsBigLedgerPeer
}
newtype MinimalInitiatorContext addr = MinimalInitiatorContext {
- micConnectionId :: ConnectionId addr
}
newtype ResponderContext addr = ResponderContext {
- rcConnectionId :: ConnectionId addr
}
data ConnectionId addr = ConnectionId {
- localAddress :: !addr
- remoteAddress :: !addr
}
data ControlMessage
- = Continue
- | Quiesce
- | Terminate
type ControlMessageSTM (m :: Type -> Type) = STM m ControlMessage
type RemoteAddress = SockAddr
type RemoteConnectionId = ConnectionId RemoteAddress
data IsBigLedgerPeer
- = IsBigLedgerPeer
- | IsNotBigLedgerPeer
data ProtocolLimitFailure
data Handshake (vNumber :: k) (vParams :: k1)
data LocalAddresses addr = LocalAddresses {
- laIpv4 :: Maybe addr
- laIpv6 :: Maybe addr
- laUnix :: Maybe addr
}
data Socket
data ExceptionInHandler where
- ExceptionInHandler :: forall peerAddr. (Typeable peerAddr, Show peerAddr) => !peerAddr -> !SomeException -> ExceptionInHandler
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
peerSharingMiniProtocolNum :: MiniProtocolNum

Documentation

nodeToNodeProtocols Source #

Arguments

:: MiniProtocolParameters
-> NodeToNodeProtocols muxMode initiatorCtx responderCtx bytes m a b
-> NodeToNodeVersion
-> PeerSharing	Node's own PeerSharing value
-> OuroborosBundle muxMode initiatorCtx responderCtx bytes m a b

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 initiatorCtx responderCtx bytes m a b Source #

Constructors

NodeToNodeProtocols

Fields

chainSyncProtocol :: RunMiniProtocol appType initiatorCtx responderCtx bytes m a b
chain-sync mini-protocol
blockFetchProtocol :: RunMiniProtocol appType initiatorCtx responderCtx bytes m a b
block-fetch mini-protocol
txSubmissionProtocol :: RunMiniProtocol appType initiatorCtx responderCtx bytes m a b
tx-submission mini-protocol
keepAliveProtocol :: RunMiniProtocol appType initiatorCtx responderCtx bytes m a b
keep-alive mini-protocol
peerSharingProtocol :: RunMiniProtocol appType initiatorCtx responderCtx bytes m a b
peer sharing mini-protocol

type NodeToNodeProtocolsWithExpandedCtx appType ntnAddr bytes m a b = NodeToNodeProtocols appType (ExpandedInitiatorContext ntnAddr m) (ResponderContext ntnAddr) bytes m a b Source #

type NodeToNodeProtocolsWithMinimalCtx appType ntnAddr bytes m a b = NodeToNodeProtocols appType (MinimalInitiatorContext ntnAddr) (ResponderContext ntnAddr) bytes m a b Source #

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 #

Constructors

NodeToNodeV_7
NodeToNodeV_8
NodeToNodeV_9
NodeToNodeV_10
NodeToNodeV_11
NodeToNodeV_12
NodeToNodeV_13

Instances

Instances details

Bounded NodeToNodeVersion
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods minBound :: NodeToNodeVersion Source # maxBound :: NodeToNodeVersion Source #
Enum NodeToNodeVersion
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 #
Show NodeToNodeVersion
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods showsPrec :: Int -> NodeToNodeVersion -> ShowS Source # show :: NodeToNodeVersion -> String Source # showList :: [NodeToNodeVersion] -> ShowS Source #
Eq NodeToNodeVersion
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods (==) :: NodeToNodeVersion -> NodeToNodeVersion -> Bool Source # (/=) :: NodeToNodeVersion -> NodeToNodeVersion -> Bool Source #
Ord NodeToNodeVersion
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 #

data NodeToNodeVersionData #

Constructors

NodeToNodeVersionData
Fields networkMagic :: !NetworkMagic diffusionMode :: !DiffusionMode peerSharing :: !PeerSharing query :: !Bool

Instances

Instances details

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

data NetworkConnectTracers addr vNumber #

Constructors

NetworkConnectTracers
Fields 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 (OuroborosApplicationWithMinimalCtx InitiatorMode SockAddr ByteString IO a b) -> Maybe SockAddr -> SockAddr -> IO () Source #

A specialised version of connectToNode.

data NetworkServerTracers addr vNumber #

Constructors

NetworkServerTracers
Fields 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 #

Constructors

NetworkMutableState
Fields nmsConnectionTable :: ConnectionTable IO addr nmsPeerStates :: StrictTVar IO (PeerStates IO addr)

data AcceptedConnectionsLimit #

Constructors

AcceptedConnectionsLimit
Fields acceptedConnectionsHardLimit :: !Word32 acceptedConnectionsSoftLimit :: !Word32 acceptedConnectionsDelay :: !DiffTime

Instances

Instances details

Show AcceptedConnectionsLimit
Instance details Defined in Ouroboros.Network.Server.RateLimiting Methods showsPrec :: Int -> AcceptedConnectionsLimit -> ShowS Source # show :: AcceptedConnectionsLimit -> String Source # showList :: [AcceptedConnectionsLimit] -> ShowS Source #
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 #

newNetworkMutableState :: IO (NetworkMutableState addr) #

newNetworkMutableStateSTM :: STM (NetworkMutableState addr) #

cleanNetworkMutableState :: NetworkMutableState addr -> IO () #

withServer Source #

Arguments

:: SocketSnocket
-> NetworkServerTracers SockAddr NodeToNodeVersion
-> NetworkMutableState SockAddr
-> AcceptedConnectionsLimit
-> Socket	a configured socket to be used be the server. The server will call `bind` and `listen` methods but it will not set any socket or tcp options on it.
-> Versions NodeToNodeVersion NodeToNodeVersionData (OuroborosApplicationWithMinimalCtx ResponderMode SockAddr ByteString IO a b)
-> ErrorPolicies
-> IO Void

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 PeerAdvertise #

Constructors

DoNotAdvertisePeer
DoAdvertisePeer

Instances

Instances details

FromJSON PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Methods parseJSON :: Value -> Parser PeerAdvertise parseJSONList :: Value -> Parser [PeerAdvertise] omittedField :: Maybe PeerAdvertise
ToJSON PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Methods toJSON :: PeerAdvertise -> Value toEncoding :: PeerAdvertise -> Encoding toJSONList :: [PeerAdvertise] -> Value toEncodingList :: [PeerAdvertise] -> Encoding omitField :: PeerAdvertise -> Bool
Generic PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Associated Types type Rep PeerAdvertise :: Type -> Type Source # Methods from :: PeerAdvertise -> Rep PeerAdvertise x Source # to :: Rep PeerAdvertise x -> PeerAdvertise Source #
Show PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Methods showsPrec :: Int -> PeerAdvertise -> ShowS Source # show :: PeerAdvertise -> String Source # showList :: [PeerAdvertise] -> ShowS Source #
Eq PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise Methods (==) :: PeerAdvertise -> PeerAdvertise -> Bool Source # (/=) :: PeerAdvertise -> PeerAdvertise -> Bool Source #
Ord PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise 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 #
type Rep PeerAdvertise
Instance details Defined in Ouroboros.Network.PeerSelection.PeerAdvertise type Rep PeerAdvertise = D1 ('MetaData "PeerAdvertise" "Ouroboros.Network.PeerSelection.PeerAdvertise" "ouroboros-network-api-0.6.1.0-5ZJryZo7Z8Q51J9KZLwxMb" '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
The target number of all known peers. This includes ledger, big ledger peers.
targetNumberOfEstablishedPeers :: !Int
The target number of established peers (does not include big ledger peers).
The target includes root peers, local root peers, ledger peers and big ledger peers.
targetNumberOfActivePeers :: !Int
The target number of active peers (does not include big ledger peers).
The
targetNumberOfKnownBigLedgerPeers :: !Int
Target number of known big ledger peers.
This target is independent of targetNumberOfKnownPeers. The total number of known peers will be sum of the two targets.
targetNumberOfEstablishedBigLedgerPeers :: !Int
Target number of established big ledger peers.
This target is independent of targetNumberOfEstablishedPeers. The total number of established peers will be sum of the two targets and local root peers.
targetNumberOfActiveBigLedgerPeers :: !Int
Target number of active big ledger peers.
This target is independent of targetNumberOfActivePeers. The total number of active peers will be sum of the two targets and active local root peers.

Instances

Instances details

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 #
Eq PeerSelectionTargets Source #
Instance details Defined in Ouroboros.Network.PeerSelection.Governor.Types Methods (==) :: PeerSelectionTargets -> PeerSelectionTargets -> Bool Source # (/=) :: PeerSelectionTargets -> PeerSelectionTargets -> Bool Source #

Subscription Workers

IP subscription worker

data IPSubscriptionTarget #

Constructors

IPSubscriptionTarget
Fields ispIps :: ![SockAddr] ispValency :: !Int

Instances

Instances details

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

Constructors

SubscriptionParams
Fields 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 (OuroborosApplicationWithMinimalCtx mode SockAddr ByteString IO x y) -> IO Void Source #

ipSubscriptionWorker which starts given application versions on each established connection.

DNS subscription worker

data DnsSubscriptionTarget #

Constructors

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

Instances

Instances details

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

type DnsSubscriptionParams a = SubscriptionParams a DnsSubscriptionTarget #

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 (OuroborosApplicationWithMinimalCtx 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 #

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 #

Constructors

InitiatorOnlyDiffusionMode
InitiatorAndResponderDiffusionMode

Instances

Instances details

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

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 #

Codecs

nodeToNodeHandshakeCodec :: forall (m :: Type -> Type). MonadST m => Codec (Handshake NodeToNodeVersion Term) DeserialiseFailure m ByteString #

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

nodeToNodeCodecCBORTerm :: NodeToNodeVersion -> CodecCBORTerm Text NodeToNodeVersionData #

Re-exports

data ExpandedInitiatorContext addr (m :: Type -> Type) #

Constructors

ExpandedInitiatorContext
Fields eicConnectionId :: !(ConnectionId addr) eicControlMessage :: !(ControlMessageSTM m) eicIsBigLedgerPeer :: !IsBigLedgerPeer

newtype MinimalInitiatorContext addr #

Constructors

MinimalInitiatorContext
Fields micConnectionId :: ConnectionId addr

Instances

Instances details

Functor MinimalInitiatorContext
Instance details Defined in Ouroboros.Network.Context Methods fmap :: (a -> b) -> MinimalInitiatorContext a -> MinimalInitiatorContext b Source # (<$) :: a -> MinimalInitiatorContext b -> MinimalInitiatorContext a Source #

newtype ResponderContext addr #

Constructors

ResponderContext
Fields rcConnectionId :: ConnectionId addr

Instances

Instances details

Functor ResponderContext
Instance details Defined in Ouroboros.Network.Context Methods fmap :: (a -> b) -> ResponderContext a -> ResponderContext b Source # (<$) :: a -> ResponderContext b -> ResponderContext a Source #

data ConnectionId addr #

Constructors

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

Instances

Instances details

Functor ConnectionId
Instance details Defined in Ouroboros.Network.ConnectionId Methods fmap :: (a -> b) -> ConnectionId a -> ConnectionId b Source # (<$) :: a -> ConnectionId b -> ConnectionId a Source #
ShowProxy addr => ShowProxy (ConnectionId addr :: Type)
Instance details Defined in Ouroboros.Network.ConnectionId Methods showProxy :: Proxy (ConnectionId addr) -> String
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 #
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 #
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 #
Hashable a => Hashable (ConnectionId a)
Instance details Defined in Ouroboros.Network.ConnectionId Methods hashWithSalt :: Int -> ConnectionId a -> Int hash :: ConnectionId a -> Int
Typeable addr => NoThunks (ConnectionId addr)
Instance details Defined in Ouroboros.Network.ConnectionId Methods noThunks :: Context -> ConnectionId addr -> IO (Maybe ThunkInfo) wNoThunks :: Context -> ConnectionId addr -> IO (Maybe ThunkInfo) showTypeOf :: Proxy (ConnectionId addr) -> String
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.10.1.0-6oc7eN9E7cu67rZ3WydsD2" 'False) (C1 ('MetaCons "ConnectionId" 'PrefixI 'True) (S1 ('MetaSel ('Just "localAddress") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 addr) :*: S1 ('MetaSel ('Just "remoteAddress") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 addr)))

data ControlMessage #

Constructors

Continue
Quiesce
Terminate

Instances

Instances details

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

type ControlMessageSTM (m :: Type -> Type) = STM m ControlMessage #

type RemoteAddress = SockAddr Source #

type RemoteConnectionId = ConnectionId RemoteAddress Source #

data IsBigLedgerPeer #

Constructors

IsBigLedgerPeer
IsNotBigLedgerPeer

Instances

Instances details

Eq IsBigLedgerPeer
Instance details Defined in Ouroboros.Network.PeerSelection.LedgerPeers.Type Methods (==) :: IsBigLedgerPeer -> IsBigLedgerPeer -> Bool Source # (/=) :: IsBigLedgerPeer -> IsBigLedgerPeer -> Bool Source #

data ProtocolLimitFailure #

Instances

Instances details

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

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

Instances

Instances details

ShowProxy (Handshake vNumber vParams :: Type)
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type Methods showProxy :: Proxy (Handshake vNumber vParams) -> String
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' data ClientHasAgency st data ServerHasAgency st data NobodyHasAgency st Methods exclusionLemma_ClientAndServerHaveAgency :: forall (st :: Handshake vNumber vParams). ClientHasAgency st -> ServerHasAgency st -> Void exclusionLemma_NobodyAndClientHaveAgency :: forall (st :: Handshake vNumber vParams). NobodyHasAgency st -> ClientHasAgency st -> Void exclusionLemma_NobodyAndServerHaveAgency :: forall (st :: Handshake vNumber vParams). NobodyHasAgency st -> ServerHasAgency st -> Void
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 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) MsgQueryReply :: 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 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 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 LocalAddresses addr #

Constructors

LocalAddresses
Fields laIpv4 :: Maybe addr laIpv6 :: Maybe addr laUnix :: Maybe addr

Instances

Instances details

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 #
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 #
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 #

data Socket #

Instances

Instances details

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

Exceptions

data ExceptionInHandler where #

Constructors

ExceptionInHandler :: forall peerAddr. (Typeable peerAddr, Show peerAddr) => !peerAddr -> !SomeException -> ExceptionInHandler

Instances

Instances details

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

Error Policies and Peer state

data ErrorPolicies #

Constructors

ErrorPolicies
Fields epAppErrorPolicies :: [ErrorPolicy] epConErrorPolicies :: [ErrorPolicy]

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 #

data ErrorPolicy where #

Constructors

ErrorPolicy :: forall e. Exception e => (e -> Maybe (SuspendDecision DiffTime)) -> 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 #

Constructors

SuspendPeer !t !t
SuspendConsumer !t
Throw

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 #
Ord t => Semigroup (SuspendDecision t)
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 #
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 #
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 #
SAct (SuspendDecision Time) (Maybe (PeerState m))
Instance details Defined in Ouroboros.Network.Subscription.PeerState Methods (<\|) :: Maybe (PeerState m) -> SuspendDecision Time -> Maybe (PeerState m)

Traces

data AcceptConnectionsPolicyTrace #

Constructors

ServerTraceAcceptConnectionRateLimiting DiffTime Int
ServerTraceAcceptConnectionHardLimit Word32
ServerTraceAcceptConnectionResume Int

Instances

Instances details

Show AcceptConnectionsPolicyTrace
Instance details Defined in Ouroboros.Network.Server.RateLimiting Methods showsPrec :: Int -> AcceptConnectionsPolicyTrace -> ShowS Source # show :: AcceptConnectionsPolicyTrace -> String Source # showList :: [AcceptConnectionsPolicyTrace] -> ShowS Source #
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 #

data TraceSendRecv ps where #

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 #

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 #

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 #

Constructors

ErrorPolicySuspendPeer (Maybe (ConnectionOrApplicationExceptionTrace SomeException)) DiffTime DiffTime
ErrorPolicySuspendConsumer (Maybe (ConnectionOrApplicationExceptionTrace SomeException)) DiffTime
ErrorPolicyLocalNodeError (ConnectionOrApplicationExceptionTrace SomeException)
ErrorPolicyResumePeer
ErrorPolicyKeepSuspended
ErrorPolicyResumeConsumer
ErrorPolicyResumeProducer
ErrorPolicyUnhandledApplicationException SomeException
ErrorPolicyUnhandledConnectionException SomeException
ErrorPolicyAcceptException IOException

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 #

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 #

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 #

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 #

peerSharingMiniProtocolNum :: MiniProtocolNum Source #

Orphan instances

ShowProxy RemoteAddress Source #
Instance details Methods showProxy :: Proxy RemoteAddress -> String

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