Safe Haskell	None
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 :: ( ConnectionId addr -> STM m ControlMessage -> NodeToClientProtocols appType bytes m a b) -> NodeToClientVersion -> OuroborosApplication appType addr bytes m a b
data NodeToClientProtocols appType bytes m a b = NodeToClientProtocols {
- localChainSyncProtocol :: RunMiniProtocol appType bytes m a b
- localTxSubmissionProtocol :: RunMiniProtocol appType bytes m a b
- localStateQueryProtocol :: RunMiniProtocol appType bytes m a b
- localTxMonitorProtocol :: RunMiniProtocol appType bytes m a b
}
data NodeToClientVersion
- = NodeToClientV_9
- | NodeToClientV_10
- | NodeToClientV_11
- | NodeToClientV_12
- | NodeToClientV_13
newtype NodeToClientVersionData = NodeToClientVersionData {
- networkMagic :: NetworkMagic
}
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 ( OuroborosApplication 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 ( OuroborosApplication 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 ( OuroborosApplication mode LocalAddress ByteString IO x y) -> IO Void
chainSyncPeerNull :: forall (header :: Type ) (point :: Type ) (tip :: Type ) m a. MonadTimer m => Peer ( ChainSync header point tip) AsClient StIdle m a
localStateQueryPeerNull :: forall (block :: Type ) (point :: Type ) (query :: Type -> Type ) m a. MonadTimer m => Peer ( LocalStateQuery block point query) AsClient StIdle m a
localTxSubmissionPeerNull :: forall (tx :: Type ) (reject :: Type ) m a. MonadTimer m => Peer ( LocalTxSubmission tx reject) AsClient StIdle m a
localTxMonitorPeerNull :: forall (txid :: Type ) (tx :: Type ) (slot :: Type ) m a. MonadTimer 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 -> ( ConnectionId LocalAddress -> STM m ControlMessage -> NodeToClientProtocols appType bytes m a b) -> Versions NodeToClientVersion NodeToClientVersionData ( OuroborosApplication 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 :: 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
}
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 :: ( ConnectionId addr -> STM m ControlMessage -> NodeToClientProtocols appType bytes m a b) -> NodeToClientVersion -> OuroborosApplication 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 bytes m a b Source #

Recorod of node-to-client mini protocols.

Constructors

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

data NodeToClientVersion Source #

Enumeration of node to client protocol versions.

Constructors

NodeToClientV_9	enabled `CardanoNodeToClientVersion7` , i.e., Alonzo
NodeToClientV_10	added `GetChainBlockNo` and `GetChainPoint` queries
NodeToClientV_11	added `GetRewardInfoPools` Block query
NodeToClientV_12	added `LocalTxMonitor` mini-protocol
NodeToClientV_13	enabled `CardanoNodeToClientVersion9` , i.e., Babbage

Instances

Instances details

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

newtype NodeToClientVersionData Source #

Version data for NodeToClient protocol v1

Constructors

NodeToClientVersionData
Fields networkMagic :: NetworkMagic

Instances

Instances details

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

data NetworkConnectTracers addr vNumber Source #

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

Constructors

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

nullNetworkConnectTracers :: NetworkConnectTracers addr vNumber Source #

connectTo Source #

Arguments

:: LocalSnocket	callback constructed by `withIOManager`
-> NetworkConnectTracers LocalAddress NodeToClientVersion
-> Versions NodeToClientVersion NodeToClientVersionData ( OuroborosApplication 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 Source #

Tracers required by a server which handles inbound connections.

Constructors

NetworkServerTracers

Fields

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

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

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

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

tracing rate limiting of accepting connections.

nullNetworkServerTracers :: NetworkServerTracers addr vNumber Source #

data NetworkMutableState addr Source #

Mutable state maintained by the network component.

Constructors

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

newNetworkMutableState :: IO ( NetworkMutableState addr) Source #

newNetworkMutableStateSTM :: STM ( NetworkMutableState addr) Source #

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

Clean PeerStates within NetworkMutableState every 200s

withServer :: LocalSnocket -> NetworkServerTracers LocalAddress NodeToClientVersion -> NetworkMutableState LocalAddress -> LocalSocket -> Versions NodeToClientVersion NodeToClientVersionData ( OuroborosApplication 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 Source #

Constructors

ClientSubscriptionParams
Fields cspAddress :: ! LocalAddress unix socket or named pipe address cspConnectionAttemptDelay :: !( Maybe DiffTime ) delay between connection attempts cspErrorPolicies :: ! ErrorPolicies error policies for subscription worker

ncSubscriptionWorker :: forall mode x y. HasInitiator mode ~ True => LocalSnocket -> NetworkClientSubcriptionTracers -> NetworkMutableState LocalAddress -> ClientSubscriptionParams () -> Versions NodeToClientVersion NodeToClientVersionData ( OuroborosApplication 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. MonadTimer m => Peer ( ChainSync header point tip) AsClient StIdle m a Source #

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

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

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

Re-exported network interface

newtype IOManager Source #

This is public api to interact with the io manager; On Windows IOManager holds associateWithIOCompletionPort ; on other platforms IOManager can run over any type, and thus is guaranteed to be no-op.

Constructors

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

type AssociateWithIOCP = IOManager Source #

withIOManager :: WithIOManager Source #

withIOManager allows to do asynchronous io on Windows hiding the differences between posix and Win32.

It starts an io manger thread, which should be only one running at a time, so the best place to call it is very close to the main function and last for duration of the application.

Async IO operations which are using the iocp port should not leak out-side of withIOManager . They will be silently cancelled when withIOManager exists. In particular one should not return IOManager from withIOManager .

type LocalSnocket = Snocket IO LocalSocket LocalAddress Source #

System dependent LocalSnocket

localSnocket :: IOManager -> LocalSnocket Source #

Create a LocalSnocket .

On Windows , there is no way to get path associated to a named pipe. To go around this, the address passed to open via LocalFamily will be referenced by LocalSocket .

newtype LocalSocket Source #

System dependent LocalSnocket type

Constructors

LocalSocket
Fields getLocalHandle :: LocalHandle

Instances

Instances details

Eq LocalSocket
Instance details Defined in Ouroboros.Network.Snocket Methods (==) :: LocalSocket -> LocalSocket -> Bool Source # (/=) :: LocalSocket -> LocalSocket -> Bool Source #
Show LocalSocket
Instance details Defined in Ouroboros.Network.Snocket Methods showsPrec :: Int -> LocalSocket -> ShowS Source # show :: LocalSocket -> String Source # showList :: [ LocalSocket ] -> ShowS Source #
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 #
type Rep LocalSocket
Instance details Defined in Ouroboros.Network.Snocket type Rep LocalSocket = D1 (' MetaData "LocalSocket" "Ouroboros.Network.Snocket" "ouroboros-network-framework-0.1.0.1-8Cos8Lgj9CwATl9eblNk02" ' True ) ( C1 (' MetaCons "LocalSocket" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getLocalHandle") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 LocalHandle)))

newtype LocalAddress Source #

Local address, on Unix is associated with AF_UNIX family, on

Windows with `named-pipes`.

Constructors

LocalAddress
Fields getFilePath :: FilePath

Instances

Instances details

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 #
Show LocalAddress
Instance details Defined in Ouroboros.Network.Snocket Methods showsPrec :: Int -> LocalAddress -> ShowS Source # show :: LocalAddress -> String Source # showList :: [ LocalAddress ] -> ShowS Source #
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 #
Hashable LocalAddress
Instance details Defined in Ouroboros.Network.Snocket Methods hashWithSalt :: Int -> LocalAddress -> Int Source # hash :: LocalAddress -> Int Source #
type Rep LocalAddress
Instance details Defined in Ouroboros.Network.Snocket type Rep LocalAddress = D1 (' MetaData "LocalAddress" "Ouroboros.Network.Snocket" "ouroboros-network-framework-0.1.0.1-8Cos8Lgj9CwATl9eblNk02" ' True ) ( C1 (' MetaCons "LocalAddress" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getFilePath") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 FilePath )))

Versions

newtype Versions vNum vData r Source #

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

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

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

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

Constructors

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

Instances

Instances details

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

versionedNodeToClientProtocols :: NodeToClientVersion -> NodeToClientVersionData -> ( ConnectionId LocalAddress -> STM m ControlMessage -> NodeToClientProtocols appType bytes m a b) -> Versions NodeToClientVersion NodeToClientVersionData ( OuroborosApplication appType LocalAddress bytes m a b) Source #

Versions containing a single version of nodeToClientProtocols .

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

Singleton smart constructor for Versions .

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

Useful for folding multiple Versions .

A foldMap restricted to the Versions Semigroup .

PRECONDITION: f x is non-empty.

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

Codecs

nodeToClientHandshakeCodec :: MonadST m => Codec ( Handshake NodeToClientVersion Term ) DeserialiseFailure m ByteString Source #

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

We set 16ths bit to distinguish NodeToNodeVersion and NodeToClientVersion . This way connecting wrong protocol suite will fail during Handshake negotiation

This is done in backward compatible way, so NodeToClientV_1 encoding is not changed.

nodeToClientCodecCBORTerm :: NodeToClientVersion -> CodecCBORTerm Text NodeToClientVersionData Source #

Re-exports

data ConnectionId addr Source #

Connection is identified by local and remote address.

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

Constructors

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

Instances

Instances details

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

type LocalConnectionId = ConnectionId LocalAddress Source #

data ErrorPolicies Source #

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

Constructors

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

Instances

Instances details

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

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

data ErrorPolicy where Source #

Constructors

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

Instances

Instances details

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

data ErrorPolicyTrace Source #

Trace data for error policies

Constructors

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

Instances

Instances details

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

data WithAddr addr a Source #

Constructors

WithAddr
Fields wiaAddr :: addr wiaEvent :: a

Instances

Instances details

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

data SuspendDecision t Source #

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

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

Constructors

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

Instances

Instances details

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

data TraceSendRecv ps where Source #

Structured Tracer output for runPeer and derivitives.

Constructors

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

Instances

Instances details

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

data ProtocolLimitFailure Source #

Instances

Instances details

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

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

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

Instances

Instances details

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

data LocalAddresses addr Source #

Constructors

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

Instances

Instances details

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

data SubscriptionTrace addr Source #

Constructors

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

Instances

Instances details

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

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