Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.NodeToClient

Contents

Null Protocol Peers
Re-exported network interface
Versions
- Codecs
Re-exports

Description

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

Synopsis

nodeToClientProtocols :: NodeToClientProtocols appType addr bytes m a b -> NodeToClientVersion -> OuroborosApplicationWithMinimalCtx appType addr bytes m a b
data NodeToClientProtocols appType ntcAddr bytes m a b = NodeToClientProtocols {
- localChainSyncProtocol :: RunMiniProtocolWithMinimalCtx appType ntcAddr bytes m a b
- localTxSubmissionProtocol :: RunMiniProtocolWithMinimalCtx appType ntcAddr bytes m a b
- localStateQueryProtocol :: RunMiniProtocolWithMinimalCtx appType ntcAddr bytes m a b
- localTxMonitorProtocol :: RunMiniProtocolWithMinimalCtx appType ntcAddr bytes m a b
}
data NodeToClientVersion
- = NodeToClientV_9
- | NodeToClientV_10
- | NodeToClientV_11
- | NodeToClientV_12
- | NodeToClientV_13
- | NodeToClientV_14
- | NodeToClientV_15
- | NodeToClientV_16
data NodeToClientVersionData = NodeToClientVersionData {
- networkMagic :: !NetworkMagic
- 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 :: LocalSnocket -> NetworkConnectTracers LocalAddress NodeToClientVersion -> Versions NodeToClientVersion NodeToClientVersionData (OuroborosApplicationWithMinimalCtx InitiatorMode LocalAddress ByteString IO a b) -> FilePath -> 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)
}
newNetworkMutableState :: IO (NetworkMutableState addr)
newNetworkMutableStateSTM :: STM (NetworkMutableState addr)
cleanNetworkMutableState :: NetworkMutableState addr -> IO ()
withServer :: LocalSnocket -> NetworkServerTracers LocalAddress NodeToClientVersion -> NetworkMutableState LocalAddress -> LocalSocket -> Versions NodeToClientVersion NodeToClientVersionData (OuroborosApplicationWithMinimalCtx ResponderMode LocalAddress ByteString IO a b) -> ErrorPolicies -> IO Void
type NetworkClientSubcriptionTracers = NetworkSubscriptionTracers Identity LocalAddress NodeToClientVersion
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))
}
data ClientSubscriptionParams a = ClientSubscriptionParams {
- cspAddress :: !LocalAddress
- cspConnectionAttemptDelay :: !(Maybe DiffTime)
- cspErrorPolicies :: !ErrorPolicies
}
ncSubscriptionWorker :: forall mode x y. HasInitiator mode ~ True => LocalSnocket -> NetworkClientSubcriptionTracers -> NetworkMutableState LocalAddress -> ClientSubscriptionParams () -> Versions NodeToClientVersion NodeToClientVersionData (OuroborosApplicationWithMinimalCtx mode LocalAddress ByteString IO x y) -> IO Void
chainSyncPeerNull :: forall (header :: Type) (point :: Type) (tip :: Type) m a. MonadDelay m => Peer (ChainSync header point tip) AsClient StIdle m a
localStateQueryPeerNull :: forall (block :: Type) (point :: Type) (query :: Type -> Type) m a. MonadDelay m => Peer (LocalStateQuery block point query) AsClient StIdle m a
localTxSubmissionPeerNull :: forall (tx :: Type) (reject :: Type) m a. MonadDelay m => Peer (LocalTxSubmission tx reject) AsClient StIdle m a
localTxMonitorPeerNull :: forall (txid :: Type) (tx :: Type) (slot :: Type) m a. MonadDelay m => Peer (LocalTxMonitor txid tx slot) AsClient StIdle m a
newtype IOManager = IOManager {
- associateWithIOManager :: forall hole. hole -> IO ()
}
type AssociateWithIOCP = IOManager
withIOManager :: WithIOManager
type LocalSnocket = Snocket IO LocalSocket LocalAddress
localSnocket :: IOManager -> LocalSnocket
newtype LocalSocket = LocalSocket {
- getLocalHandle :: LocalHandle
}
newtype LocalAddress = LocalAddress {
- getFilePath :: FilePath
}
newtype Versions vNum vData r = Versions {
- getVersions :: Map vNum (Version vData r)
}
versionedNodeToClientProtocols :: NodeToClientVersion -> NodeToClientVersionData -> NodeToClientProtocols appType LocalAddress bytes m a b -> Versions NodeToClientVersion NodeToClientVersionData (OuroborosApplicationWithMinimalCtx appType LocalAddress bytes m a b)
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
nodeToClientHandshakeCodec :: forall (m :: Type -> Type). MonadST m => Codec (Handshake NodeToClientVersion Term) DeserialiseFailure m ByteString
nodeToClientVersionCodec :: CodecCBORTerm (Text, Maybe Int) NodeToClientVersion
nodeToClientCodecCBORTerm :: NodeToClientVersion -> CodecCBORTerm Text NodeToClientVersionData
data ConnectionId addr = ConnectionId {
- localAddress :: !addr
- remoteAddress :: !addr
}
newtype MinimalInitiatorContext addr = MinimalInitiatorContext {
- micConnectionId :: ConnectionId addr
}
newtype ResponderContext addr = ResponderContext {
- rcConnectionId :: ConnectionId addr
}
type LocalConnectionId = ConnectionId LocalAddress
data ErrorPolicies = ErrorPolicies {
- epAppErrorPolicies :: [ErrorPolicy]
- epConErrorPolicies :: [ErrorPolicy]
}
networkErrorPolicies :: ErrorPolicies
nullErrorPolicies :: ErrorPolicies
data ErrorPolicy where
- ErrorPolicy :: forall e. Exception e => (e -> Maybe (SuspendDecision DiffTime)) -> ErrorPolicy
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 WithAddr addr a = WithAddr {
- wiaAddr :: addr
- wiaEvent :: a
}
data SuspendDecision t
- = SuspendPeer !t !t
- | SuspendConsumer !t
- | Throw
data TraceSendRecv ps where
- TraceSendMsg :: forall ps. AnyMessageAndAgency ps -> TraceSendRecv ps
- TraceRecvMsg :: forall ps. AnyMessageAndAgency ps -> TraceSendRecv ps
data ProtocolLimitFailure
data Handshake (vNumber :: k) (vParams :: k1)
data LocalAddresses addr = LocalAddresses {
- laIpv4 :: Maybe addr
- laIpv6 :: Maybe addr
- laUnix :: Maybe addr
}
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
type HandshakeTr ntcAddr ntcVersion = WithMuxBearer (ConnectionId ntcAddr) (TraceSendRecv (Handshake ntcVersion Term))

Documentation

nodeToClientProtocols :: NodeToClientProtocols appType addr bytes m a b -> NodeToClientVersion -> OuroborosApplicationWithMinimalCtx appType addr bytes m a b Source #

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

This function specifies the wire format protocol numbers as well as the protocols that run for each NodeToClientVersion.

They are chosen to not overlap with the node to node protocol numbers. 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 NodeToClientProtocols appType ntcAddr bytes m a b Source #

Record of node-to-client mini protocols.

Constructors

NodeToClientProtocols

Fields

localChainSyncProtocol :: RunMiniProtocolWithMinimalCtx appType ntcAddr bytes m a b
local chain-sync mini-protocol
localTxSubmissionProtocol :: RunMiniProtocolWithMinimalCtx appType ntcAddr bytes m a b
local tx-submission mini-protocol
localStateQueryProtocol :: RunMiniProtocolWithMinimalCtx appType ntcAddr bytes m a b
local state-query mini-protocol
localTxMonitorProtocol :: RunMiniProtocolWithMinimalCtx appType ntcAddr bytes m a b
local tx-monitor mini-protocol

data NodeToClientVersion #

Constructors

NodeToClientV_9
NodeToClientV_10
NodeToClientV_11
NodeToClientV_12
NodeToClientV_13
NodeToClientV_14
NodeToClientV_15
NodeToClientV_16

Instances

Instances details

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

data NodeToClientVersionData #

Constructors

NodeToClientVersionData
Fields networkMagic :: !NetworkMagic query :: !Bool

Instances

Instances details

Show NodeToClientVersionData
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods showsPrec :: Int -> NodeToClientVersionData -> ShowS Source # show :: NodeToClientVersionData -> String Source # showList :: [NodeToClientVersionData] -> ShowS Source #
Eq NodeToClientVersionData
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods (==) :: NodeToClientVersionData -> NodeToClientVersionData -> Bool Source # (/=) :: NodeToClientVersionData -> NodeToClientVersionData -> Bool Source #
Acceptable NodeToClientVersionData
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods acceptableVersion :: NodeToClientVersionData -> NodeToClientVersionData -> Accept NodeToClientVersionData
Queryable NodeToClientVersionData
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods queryVersion :: NodeToClientVersionData -> 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 Source #

Arguments

:: LocalSnocket	callback constructed by `withIOManager`
-> NetworkConnectTracers LocalAddress NodeToClientVersion
-> Versions NodeToClientVersion NodeToClientVersionData (OuroborosApplicationWithMinimalCtx InitiatorMode LocalAddress ByteString IO a b)	A dictionary of protocol versions & applications to run on an established connection. The application to run will be chosen by initial handshake protocol (the highest shared version will be chosen).
-> FilePath	path of the unix socket or named pipe
-> IO ()

A specialised version of connectToNode. It is a general purpose function which can connect using any version of the protocol. This is mostly useful for future enhancements.

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)

newNetworkMutableState :: IO (NetworkMutableState addr) #

newNetworkMutableStateSTM :: STM (NetworkMutableState addr) #

cleanNetworkMutableState :: NetworkMutableState addr -> IO () #

withServer :: LocalSnocket -> NetworkServerTracers LocalAddress NodeToClientVersion -> NetworkMutableState LocalAddress -> LocalSocket -> Versions NodeToClientVersion NodeToClientVersionData (OuroborosApplicationWithMinimalCtx ResponderMode LocalAddress ByteString IO a b) -> ErrorPolicies -> IO Void Source #

A specialised version of withServerNode.

Comments to withServer apply here as well.

type NetworkClientSubcriptionTracers = NetworkSubscriptionTracers Identity LocalAddress NodeToClientVersion 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.

data ClientSubscriptionParams a #

Constructors

ClientSubscriptionParams
Fields cspAddress :: !LocalAddress cspConnectionAttemptDelay :: !(Maybe DiffTime) cspErrorPolicies :: !ErrorPolicies

ncSubscriptionWorker :: forall mode x y. HasInitiator mode ~ True => LocalSnocket -> NetworkClientSubcriptionTracers -> NetworkMutableState LocalAddress -> ClientSubscriptionParams () -> Versions NodeToClientVersion NodeToClientVersionData (OuroborosApplicationWithMinimalCtx mode LocalAddress ByteString IO x y) -> IO Void Source #

ncSubscriptionWorker which starts given application versions on each established connection.

Null Protocol Peers

chainSyncPeerNull :: forall (header :: Type) (point :: Type) (tip :: Type) m a. MonadDelay m => Peer (ChainSync header point tip) AsClient StIdle m a Source #

localStateQueryPeerNull :: forall (block :: Type) (point :: Type) (query :: Type -> Type) m a. MonadDelay m => Peer (LocalStateQuery block point query) AsClient StIdle m a Source #

localTxSubmissionPeerNull :: forall (tx :: Type) (reject :: Type) m a. MonadDelay m => Peer (LocalTxSubmission tx reject) AsClient StIdle m a Source #

localTxMonitorPeerNull :: forall (txid :: Type) (tx :: Type) (slot :: Type) m a. MonadDelay m => Peer (LocalTxMonitor txid tx slot) AsClient StIdle m a Source #

Re-exported network interface

newtype IOManager #

Constructors

IOManager
Fields associateWithIOManager :: forall hole. hole -> IO ()

type AssociateWithIOCP = IOManager #

withIOManager :: WithIOManager #

type LocalSnocket = Snocket IO LocalSocket LocalAddress #

localSnocket :: IOManager -> LocalSnocket #

newtype LocalSocket #

Constructors

LocalSocket
Fields getLocalHandle :: LocalHandle

Instances

Instances details

Generic LocalSocket
Instance details Defined in Ouroboros.Network.Snocket Associated Types type Rep LocalSocket :: Type -> Type Source # Methods from :: LocalSocket -> Rep LocalSocket x Source # to :: Rep LocalSocket x -> LocalSocket Source #
Show LocalSocket
Instance details Defined in Ouroboros.Network.Snocket Methods showsPrec :: Int -> LocalSocket -> ShowS Source # show :: LocalSocket -> String Source # showList :: [LocalSocket] -> ShowS Source #
Eq LocalSocket
Instance details Defined in Ouroboros.Network.Snocket Methods (==) :: LocalSocket -> LocalSocket -> Bool Source # (/=) :: LocalSocket -> LocalSocket -> Bool Source #
type Rep LocalSocket
Instance details Defined in Ouroboros.Network.Snocket type Rep LocalSocket = D1 ('MetaData "LocalSocket" "Ouroboros.Network.Snocket" "ouroboros-network-framework-0.10.1.0-6oc7eN9E7cu67rZ3WydsD2" 'True) (C1 ('MetaCons "LocalSocket" 'PrefixI 'True) (S1 ('MetaSel ('Just "getLocalHandle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalHandle)))

newtype LocalAddress #

Constructors

LocalAddress
Fields getFilePath :: FilePath

Instances

Instances details

Generic LocalAddress
Instance details Defined in Ouroboros.Network.Snocket Associated Types type Rep LocalAddress :: Type -> Type Source # Methods from :: LocalAddress -> Rep LocalAddress x Source # to :: Rep LocalAddress x -> LocalAddress Source #
Show LocalAddress
Instance details Defined in Ouroboros.Network.Snocket Methods showsPrec :: Int -> LocalAddress -> ShowS Source # show :: LocalAddress -> String Source # showList :: [LocalAddress] -> ShowS Source #
Eq LocalAddress
Instance details Defined in Ouroboros.Network.Snocket Methods (==) :: LocalAddress -> LocalAddress -> Bool Source # (/=) :: LocalAddress -> LocalAddress -> Bool Source #
Ord LocalAddress
Instance details Defined in Ouroboros.Network.Snocket Methods compare :: LocalAddress -> LocalAddress -> Ordering Source # (<) :: LocalAddress -> LocalAddress -> Bool Source # (<=) :: LocalAddress -> LocalAddress -> Bool Source # (>) :: LocalAddress -> LocalAddress -> Bool Source # (>=) :: LocalAddress -> LocalAddress -> Bool Source # max :: LocalAddress -> LocalAddress -> LocalAddress Source # min :: LocalAddress -> LocalAddress -> LocalAddress Source #
Hashable LocalAddress
Instance details Defined in Ouroboros.Network.Snocket Methods hashWithSalt :: Int -> LocalAddress -> Int hash :: LocalAddress -> Int
type Rep LocalAddress
Instance details Defined in Ouroboros.Network.Snocket type Rep LocalAddress = D1 ('MetaData "LocalAddress" "Ouroboros.Network.Snocket" "ouroboros-network-framework-0.10.1.0-6oc7eN9E7cu67rZ3WydsD2" 'True) (C1 ('MetaCons "LocalAddress" 'PrefixI 'True) (S1 ('MetaSel ('Just "getFilePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))

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 #

versionedNodeToClientProtocols :: NodeToClientVersion -> NodeToClientVersionData -> NodeToClientProtocols appType LocalAddress bytes m a b -> Versions NodeToClientVersion NodeToClientVersionData (OuroborosApplicationWithMinimalCtx appType LocalAddress bytes m a b) Source #

Versions containing a single version of nodeToClientProtocols.

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

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

nodeToClientVersionCodec :: CodecCBORTerm (Text, Maybe Int) NodeToClientVersion #

nodeToClientCodecCBORTerm :: NodeToClientVersion -> CodecCBORTerm Text NodeToClientVersionData #

Re-exports

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

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 #

type LocalConnectionId = ConnectionId LocalAddress Source #

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 #

networkErrorPolicies :: ErrorPolicies Source #

ErrorPolicies for client application. Additional rules can be added by means of a Semigroup instance of ErrorPolicies.

This error policies will try to preserve subscriptionWorker, e.g. if the connect function throws an IOException we will suspend it for a shortDelay, and try to re-connect.

This allows to recover from a situation where a node temporarily shutsdown, or running a client application which is subscribed two more than one node (possibly over network).

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

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)

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

type HandshakeTr ntcAddr ntcVersion = WithMuxBearer (ConnectionId ntcAddr) (TraceSendRecv (Handshake ntcVersion Term)) Source #

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