Safe Haskell	None
Language	Haskell2010

Cardano.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 :: forall (appType :: Mode) addr bytes (m :: Type -> Type) a b. NodeToClientProtocols appType addr bytes m a b -> NodeToClientVersion -> NodeToClientVersionData -> OuroborosApplicationWithMinimalCtx appType addr bytes m a b
data NodeToClientProtocols (appType :: Mode) ntcAddr bytes (m :: Type -> Type) 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_16
- | NodeToClientV_17
- | NodeToClientV_18
- | NodeToClientV_19
- | NodeToClientV_20
- | NodeToClientV_21
- | NodeToClientV_22
- | NodeToClientV_23
data NodeToClientVersionData = NodeToClientVersionData {
- networkMagic :: !NetworkMagic
- query :: !Bool
}
data NetworkConnectTracers addr vNumber = NetworkConnectTracers {
- nctMuxTracers :: TracersWithBearer (ConnectionId addr) IO
- nctHandshakeTracer :: Tracer IO (WithBearer (ConnectionId addr) (TraceSendRecv (Handshake vNumber Term)))
}
nullNetworkConnectTracers :: NetworkConnectTracers addr vNumber
connectTo :: LocalSnocket -> NetworkConnectTracers LocalAddress NodeToClientVersion -> Versions NodeToClientVersion NodeToClientVersionData (OuroborosApplicationWithMinimalCtx 'InitiatorMode LocalAddress ByteString IO a Void) -> FilePath -> IO (Either SomeException a)
connectToWithMux :: LocalSnocket -> NetworkConnectTracers LocalAddress NodeToClientVersion -> Versions NodeToClientVersion NodeToClientVersionData (OuroborosApplicationWithMinimalCtx 'InitiatorMode LocalAddress ByteString IO a b) -> FilePath -> (ConnectionId LocalAddress -> NodeToClientVersion -> NodeToClientVersionData -> OuroborosApplicationWithMinimalCtx 'InitiatorMode LocalAddress ByteString IO a b -> Mux 'InitiatorMode IO -> Async IO () -> IO x) -> IO x
chainSyncPeerNull :: forall header point tip (m :: Type -> Type) a. MonadDelay m => Client (ChainSync header point tip) 'NonPipelined ('StIdle :: ChainSync header point tip) m a
localStateQueryPeerNull :: forall block point (query :: Type -> Type) (m :: Type -> Type) a. MonadDelay m => Client (LocalStateQuery block point query) ('StIdle :: LocalStateQuery block point query) (State :: LocalStateQuery block point query -> Type) m a
localTxSubmissionPeerNull :: forall tx reject (m :: Type -> Type) a. MonadDelay m => Client (LocalTxSubmission tx reject) 'NonPipelined ('StIdle :: LocalTxSubmission tx reject) m a
localTxMonitorPeerNull :: forall txid tx slot (m :: Type -> Type) a. MonadDelay m => Client (LocalTxMonitor txid tx slot) 'NonPipelined ('StIdle :: LocalTxMonitor txid tx slot) 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
}
type LocalConnectionId = ConnectionId LocalAddress
newtype Versions vNum vData r = Versions {
- getVersions :: Map vNum (Version vData r)
}
versionedNodeToClientProtocols :: forall (appType :: Mode) bytes (m :: Type -> Type) a b. NodeToClientVersion -> NodeToClientVersionData -> NodeToClientProtocols appType LocalAddress bytes m a b -> Versions NodeToClientVersion NodeToClientVersionData (OuroborosApplicationWithMinimalCtx appType LocalAddress bytes m a b)
simpleSingletonVersions :: vNum -> vData -> (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
}
data TraceSendRecv ps where
- TraceSendMsg :: forall ps. AnyMessage ps -> TraceSendRecv ps
- TraceRecvMsg :: forall ps. AnyMessage ps -> TraceSendRecv ps
data ProtocolLimitFailure
data Handshake (vNumber :: k) (vParams :: k1)

Documentation

nodeToClientProtocols :: forall (appType :: Mode) addr bytes (m :: Type -> Type) a b. NodeToClientProtocols appType addr bytes m a b -> NodeToClientVersion -> NodeToClientVersionData -> 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 :: Mode) ntcAddr bytes (m :: Type -> Type) 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_16
NodeToClientV_17
NodeToClientV_18
NodeToClientV_19
NodeToClientV_20
NodeToClientV_21
NodeToClientV_22
NodeToClientV_23

Instances

Instances details

NFData NodeToClientVersion

Instance details

Defined in Cardano.Network.NodeToClient.Version

Methods

rnf :: NodeToClientVersion -> () #

Bounded NodeToClientVersion

Instance details

Defined in Cardano.Network.NodeToClient.Version

Methods

minBound :: NodeToClientVersion #

maxBound :: NodeToClientVersion #

Enum NodeToClientVersion

Instance details

Defined in Cardano.Network.NodeToClient.Version

Methods

succ :: NodeToClientVersion -> NodeToClientVersion #

pred :: NodeToClientVersion -> NodeToClientVersion #

toEnum :: Int -> NodeToClientVersion #

fromEnum :: NodeToClientVersion -> Int #

enumFrom :: NodeToClientVersion -> [NodeToClientVersion] #

enumFromThen :: NodeToClientVersion -> NodeToClientVersion -> [NodeToClientVersion] #

enumFromTo :: NodeToClientVersion -> NodeToClientVersion -> [NodeToClientVersion] #

enumFromThenTo :: NodeToClientVersion -> NodeToClientVersion -> NodeToClientVersion -> [NodeToClientVersion] #

Generic NodeToClientVersion

Instance details

Defined in Cardano.Network.NodeToClient.Version

Associated Types

type Rep NodeToClientVersion

Instance details

Defined in Cardano.Network.NodeToClient.Version

type Rep NodeToClientVersion = D1 ('MetaData "NodeToClientVersion" "Cardano.Network.NodeToClient.Version" "cardano-diffusion-0.1.0.0-inplace-api" 'False) (((C1 ('MetaCons "NodeToClientV_16" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NodeToClientV_17" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NodeToClientV_18" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NodeToClientV_19" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "NodeToClientV_20" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NodeToClientV_21" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NodeToClientV_22" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NodeToClientV_23" 'PrefixI 'False) (U1 :: Type -> Type))))

Methods

from :: NodeToClientVersion -> Rep NodeToClientVersion x #

to :: Rep NodeToClientVersion x -> NodeToClientVersion #

Show NodeToClientVersion

Instance details

Defined in Cardano.Network.NodeToClient.Version

Methods

showsPrec :: Int -> NodeToClientVersion -> ShowS #

show :: NodeToClientVersion -> String #

showList :: [NodeToClientVersion] -> ShowS #

Eq NodeToClientVersion

Instance details

Defined in Cardano.Network.NodeToClient.Version

Methods

(==) :: NodeToClientVersion -> NodeToClientVersion -> Bool #

(/=) :: NodeToClientVersion -> NodeToClientVersion -> Bool #

Ord NodeToClientVersion

Instance details

Defined in Cardano.Network.NodeToClient.Version

Methods

compare :: NodeToClientVersion -> NodeToClientVersion -> Ordering #

(<) :: NodeToClientVersion -> NodeToClientVersion -> Bool #

(<=) :: NodeToClientVersion -> NodeToClientVersion -> Bool #

(>) :: NodeToClientVersion -> NodeToClientVersion -> Bool #

(>=) :: NodeToClientVersion -> NodeToClientVersion -> Bool #

max :: NodeToClientVersion -> NodeToClientVersion -> NodeToClientVersion #

min :: NodeToClientVersion -> NodeToClientVersion -> NodeToClientVersion #

type Rep NodeToClientVersion

Instance details

Defined in Cardano.Network.NodeToClient.Version

type Rep NodeToClientVersion = D1 ('MetaData "NodeToClientVersion" "Cardano.Network.NodeToClient.Version" "cardano-diffusion-0.1.0.0-inplace-api" 'False) (((C1 ('MetaCons "NodeToClientV_16" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NodeToClientV_17" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NodeToClientV_18" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NodeToClientV_19" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "NodeToClientV_20" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NodeToClientV_21" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NodeToClientV_22" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NodeToClientV_23" 'PrefixI 'False) (U1 :: Type -> Type))))

data NodeToClientVersionData #

Constructors

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

Instances

Instances details

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

data NetworkConnectTracers addr vNumber #

Constructors

NetworkConnectTracers
Fields nctMuxTracers :: TracersWithBearer (ConnectionId addr) IO nctHandshakeTracer :: Tracer IO (WithBearer (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 Void)	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 (Either SomeException a)

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.

connectToWithMux 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
-> (ConnectionId LocalAddress -> NodeToClientVersion -> NodeToClientVersionData -> OuroborosApplicationWithMinimalCtx 'InitiatorMode LocalAddress ByteString IO a b -> Mux 'InitiatorMode IO -> Async IO () -> IO x)	callback which has access to negotiated protocols and mux handle created for that connection. The `Async` is a handle the the thread which runs `runMux`. The `Mux` handle allows schedule mini-protocols. NOTE: when the callback returns or errors, the mux thread will be killed.
-> IO x

A version of connectTo which exposes Mux interfaces which allows to run mini-protocols and handle their termination (e.g. restart them when they terminate or error).

Null Protocol Peers

chainSyncPeerNull :: forall header point tip (m :: Type -> Type) a. MonadDelay m => Client (ChainSync header point tip) 'NonPipelined ('StIdle :: ChainSync header point tip) m a Source #

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

localTxSubmissionPeerNull :: forall tx reject (m :: Type -> Type) a. MonadDelay m => Client (LocalTxSubmission tx reject) 'NonPipelined ('StIdle :: LocalTxSubmission tx reject) m a Source #

localTxMonitorPeerNull :: forall txid tx slot (m :: Type -> Type) a. MonadDelay m => Client (LocalTxMonitor txid tx slot) 'NonPipelined ('StIdle :: LocalTxMonitor txid tx slot) m a Source #

Re-exported network interface

newtype IOManager #

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 #

withIOManager :: WithIOManager #

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 #

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
Instance details Defined in Ouroboros.Network.Snocket type Rep LocalSocket = D1 ('MetaData "LocalSocket" "Ouroboros.Network.Snocket" "ouroboros-network-0.23.0.0-inplace-framework" 'True) (C1 ('MetaCons "LocalSocket" 'PrefixI 'True) (S1 ('MetaSel ('Just "getLocalHandle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalHandle)))

Methods

from :: LocalSocket -> Rep LocalSocket x #

to :: Rep LocalSocket x -> LocalSocket #

Show LocalSocket

Instance details

Defined in Ouroboros.Network.Snocket

Methods

showsPrec :: Int -> LocalSocket -> ShowS #

show :: LocalSocket -> String #

showList :: [LocalSocket] -> ShowS #

Eq LocalSocket

Instance details

Defined in Ouroboros.Network.Snocket

Methods

(==) :: LocalSocket -> LocalSocket -> Bool #

(/=) :: LocalSocket -> LocalSocket -> Bool #

type Rep LocalSocket

Instance details

Defined in Ouroboros.Network.Snocket

type Rep LocalSocket = D1 ('MetaData "LocalSocket" "Ouroboros.Network.Snocket" "ouroboros-network-0.23.0.0-inplace-framework" '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
Instance details Defined in Ouroboros.Network.Snocket type Rep LocalAddress = D1 ('MetaData "LocalAddress" "Ouroboros.Network.Snocket" "ouroboros-network-0.23.0.0-inplace-framework" 'True) (C1 ('MetaCons "LocalAddress" 'PrefixI 'True) (S1 ('MetaSel ('Just "getFilePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))

Methods

from :: LocalAddress -> Rep LocalAddress x #

to :: Rep LocalAddress x -> LocalAddress #

Show LocalAddress

Instance details

Defined in Ouroboros.Network.Snocket

Methods

showsPrec :: Int -> LocalAddress -> ShowS #

show :: LocalAddress -> String #

showList :: [LocalAddress] -> ShowS #

Eq LocalAddress

Instance details

Defined in Ouroboros.Network.Snocket

Methods

(==) :: LocalAddress -> LocalAddress -> Bool #

(/=) :: LocalAddress -> LocalAddress -> Bool #

Ord LocalAddress

Instance details

Defined in Ouroboros.Network.Snocket

Methods

compare :: LocalAddress -> LocalAddress -> Ordering #

(<) :: LocalAddress -> LocalAddress -> Bool #

(<=) :: LocalAddress -> LocalAddress -> Bool #

(>) :: LocalAddress -> LocalAddress -> Bool #

(>=) :: LocalAddress -> LocalAddress -> Bool #

max :: LocalAddress -> LocalAddress -> LocalAddress #

min :: LocalAddress -> LocalAddress -> LocalAddress #

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-0.23.0.0-inplace-framework" 'True) (C1 ('MetaCons "LocalAddress" 'PrefixI 'True) (S1 ('MetaSel ('Just "getFilePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))

type LocalConnectionId = ConnectionId LocalAddress #

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 # (<$) :: a -> Versions vNum extra b -> Versions vNum extra a #
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 # sconcat :: NonEmpty (Versions vNum vData r) -> Versions vNum vData r # stimes :: Integral b => b -> Versions vNum vData r -> Versions vNum vData r #

versionedNodeToClientProtocols :: forall (appType :: Mode) bytes (m :: Type -> Type) a b. 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 -> (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 #

(<$) :: a -> ConnectionId b -> ConnectionId a #

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)

Instance details

Defined in Ouroboros.Network.ConnectionId

type Rep (ConnectionId addr) = D1 ('MetaData "ConnectionId" "Ouroboros.Network.ConnectionId" "ouroboros-network-0.23.0.0-inplace-framework" 'False) (C1 ('MetaCons "ConnectionId" 'PrefixI 'True) (S1 ('MetaSel ('Just "localAddress") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 addr) :*: S1 ('MetaSel ('Just "remoteAddress") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 addr)))

Methods

from :: ConnectionId addr -> Rep (ConnectionId addr) x #

to :: Rep (ConnectionId addr) x -> ConnectionId addr #

Show addr => Show (ConnectionId addr)

Instance details

Defined in Ouroboros.Network.ConnectionId

Methods

showsPrec :: Int -> ConnectionId addr -> ShowS #

show :: ConnectionId addr -> String #

showList :: [ConnectionId addr] -> ShowS #

Eq addr => Eq (ConnectionId addr)

Instance details

Defined in Ouroboros.Network.ConnectionId

Methods

(==) :: ConnectionId addr -> ConnectionId addr -> Bool #

(/=) :: ConnectionId addr -> ConnectionId addr -> Bool #

Ord addr => Ord (ConnectionId addr)

Instance details

Defined in Ouroboros.Network.ConnectionId

Methods

compare :: ConnectionId addr -> ConnectionId addr -> Ordering #

(<) :: ConnectionId addr -> ConnectionId addr -> Bool #

(<=) :: ConnectionId addr -> ConnectionId addr -> Bool #

(>) :: ConnectionId addr -> ConnectionId addr -> Bool #

(>=) :: ConnectionId addr -> ConnectionId addr -> Bool #

max :: ConnectionId addr -> ConnectionId addr -> ConnectionId addr #

min :: ConnectionId addr -> ConnectionId addr -> ConnectionId addr #

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-0.23.0.0-inplace-framework" '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 # (<$) :: a -> MinimalInitiatorContext b -> MinimalInitiatorContext a #

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 # (<$) :: a -> ResponderContext b -> ResponderContext a #

data TraceSendRecv ps where #

Constructors

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

Instances

Instances details

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

data ProtocolLimitFailure #

Instances

Instances details

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

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

(NFData vNumber, NFData vParams) => NFData (Message (Handshake vNumber vParams) from to)

Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

Methods

rnf :: Message (Handshake vNumber vParams) from to -> () #

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

show :: Message (Handshake vNumber vParams) from to -> String #

showList :: [Message (Handshake vNumber vParams) from to] -> ShowS #

Protocol (Handshake vNumber vParams)

Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

Associated Types

type StateToken
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type type StateToken = SingHandshake :: Handshake vNumber vParams -> Type

StateTokenI ('StConfirm :: Handshake vNumber vParams)

Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

Methods

stateToken :: StateToken ('StConfirm :: Handshake vNumber vParams) #

StateTokenI ('StDone :: Handshake vNumber vParams)

Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

Methods

stateToken :: StateToken ('StDone :: Handshake vNumber vParams) #

StateTokenI ('StPropose :: Handshake vNumber vParams)

Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

Methods

stateToken :: StateToken ('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)

type StateToken

Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

type StateToken = SingHandshake :: Handshake vNumber vParams -> Type

type StateAgency ('StConfirm :: Handshake vNumber vParams)

Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

type StateAgency ('StConfirm :: Handshake vNumber vParams) = 'ServerAgency

type StateAgency ('StDone :: Handshake vNumber vParams)

Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

type StateAgency ('StDone :: Handshake vNumber vParams) = 'NobodyAgency

type StateAgency ('StPropose :: Handshake vNumber vParams)

Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

type StateAgency ('StPropose :: Handshake vNumber vParams) = 'ClientAgency