Safe Haskell	None
Language	Haskell2010

Cardano.Client.Subscription

Contents

Subscription API
Re-exports

Synopsis

subscribe :: LocalSnocket -> NetworkMagic -> Map NodeToClientVersion blockVersion -> SubscriptionTracers a -> SubscriptionParams a -> (NodeToClientVersion -> blockVersion -> NodeToClientProtocols 'InitiatorMode LocalAddress ByteString IO a Void) -> IO ()
data SubscriptionParams a = SubscriptionParams {
- spAddress :: !LocalAddress
- spReconnectionDelay :: !(Maybe DiffTime)
- spCompleteCb :: Either SomeException a -> Decision
}
data SubscriptionTracers a = SubscriptionTracers {
- stMuxTracer :: Tracer IO (WithBearer (ConnectionId LocalAddress) MuxTrace)
- stHandshakeTracer :: Tracer IO (WithBearer (ConnectionId LocalAddress) (TraceSendRecv (Handshake NodeToClientVersion Term)))
- stSubscriptionTracer :: Tracer IO (SubscriptionTrace a)
}
data SubscriptionTrace a
type MuxMode = Mode
type MuxTrace = Trace
data WithBearer peerid a
data ConnectionId addr = ConnectionId {
- localAddress :: !addr
- remoteAddress :: !addr
}
newtype LocalAddress = LocalAddress {
- getFilePath :: FilePath
}
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
}
newtype MiniProtocolCb ctx bytes (m :: Type -> Type) a = MiniProtocolCb {
- runMiniProtocolCb :: ctx -> Channel m bytes -> m (a, Maybe bytes)
}
data RunMiniProtocol (mode :: Mode) initiatorCtx responderCtx bytes (m :: Type -> Type) a b where
- InitiatorProtocolOnly :: forall initiatorCtx bytes (m :: Type -> Type) a responderCtx. MiniProtocolCb initiatorCtx bytes m a -> RunMiniProtocol 'InitiatorMode initiatorCtx responderCtx bytes m a Void
- ResponderProtocolOnly :: forall responderCtx bytes (m :: Type -> Type) b initiatorCtx. MiniProtocolCb responderCtx bytes m b -> RunMiniProtocol 'ResponderMode initiatorCtx responderCtx bytes m Void b
- InitiatorAndResponderProtocol :: forall initiatorCtx bytes (m :: Type -> Type) a responderCtx b. MiniProtocolCb initiatorCtx bytes m a -> MiniProtocolCb responderCtx bytes m b -> RunMiniProtocol 'InitiatorResponderMode initiatorCtx responderCtx bytes m a b
data ControlMessage
- = Continue
- | Quiesce
- | Terminate

Subscription API

subscribe Source #

Arguments

:: LocalSnocket
-> NetworkMagic
-> Map NodeToClientVersion blockVersion	Use `supportedNodeToClientVersions` from `ouroboros-consensus`.
-> SubscriptionTracers a
-> SubscriptionParams a
-> (NodeToClientVersion -> blockVersion -> NodeToClientProtocols 'InitiatorMode LocalAddress ByteString IO a Void)
-> IO ()

Subscribe using `node-to-client` mini-protocol.

blockVersion ought to be instantiated with `BlockNodeToClientVersion blk`. The callback receives blockVersion associated with each NodeToClientVersion and can be used to create codecs with clientCodecs.

data SubscriptionParams a Source #

Constructors

SubscriptionParams
Fields spAddress :: !LocalAddress unix socket or named pipe address spReconnectionDelay :: !(Maybe DiffTime) delay between connection attempts. The default value is `5s`. spCompleteCb :: Either SomeException a -> Decision

data SubscriptionTracers a Source #

Constructors

SubscriptionTracers

Fields

stMuxTracer :: Tracer IO (WithBearer (ConnectionId LocalAddress) MuxTrace)
low level mux-network tracer, which logs mux sdu (send and received) and other low level multiplexing events.
stHandshakeTracer :: Tracer IO (WithBearer (ConnectionId LocalAddress) (TraceSendRecv (Handshake NodeToClientVersion Term)))
handshake protocol tracer; it is important for analysing version negotation mismatches.
stSubscriptionTracer :: Tracer IO (SubscriptionTrace a)

data SubscriptionTrace a Source #

Constructors

SubscriptionResult a
SubscriptionError SomeException
SubscriptionReconnect
SubscriptionTerminate

Instances

Instances details

Show a => Show (SubscriptionTrace a) Source #
Instance details Defined in Cardano.Client.Subscription Methods showsPrec :: Int -> SubscriptionTrace a -> ShowS # show :: SubscriptionTrace a -> String # showList :: [SubscriptionTrace a] -> ShowS #

Re-exports

Mux

type MuxMode = Mode Source #

type MuxTrace = Trace Source #

data WithBearer peerid a #

Type used for tracing mux events.

Instances

Instances details

Generic (WithBearer peerid a)

Instance details

Defined in Network.Mux.Trace

Associated Types

type Rep (WithBearer peerid a)

Instance details

Defined in Network.Mux.Trace

type Rep (WithBearer peerid a) = D1 ('MetaData "WithBearer" "Network.Mux.Trace" "network-mux-0.5-inplace" 'False) (C1 ('MetaCons "WithBearer" 'PrefixI 'True) (S1 ('MetaSel ('Just "wbPeerId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 peerid) :*: S1 ('MetaSel ('Just "wbEvent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)))

Methods

from :: WithBearer peerid a -> Rep (WithBearer peerid a) x #

to :: Rep (WithBearer peerid a) x -> WithBearer peerid a #

(Show peerid, Show a) => Show (WithBearer peerid a)

Instance details

Defined in Network.Mux.Trace

Methods

showsPrec :: Int -> WithBearer peerid a -> ShowS #

show :: WithBearer peerid a -> String #

showList :: [WithBearer peerid a] -> ShowS #

type Rep (WithBearer peerid a)

Instance details

Defined in Network.Mux.Trace

type Rep (WithBearer peerid a) = D1 ('MetaData "WithBearer" "Network.Mux.Trace" "network-mux-0.5-inplace" 'False) (C1 ('MetaCons "WithBearer" 'PrefixI 'True) (S1 ('MetaSel ('Just "wbPeerId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 peerid) :*: S1 ('MetaSel ('Just "wbEvent") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)))

Connections

data ConnectionId addr #

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

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-framework-0.14.0.0-inplace" '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)

Order first by remoteAddress then by localAddress.

Note: we relay on the fact that remoteAddress is an order preserving map (which allows us to use mapKeysMonotonic in some cases. We also relay on this particular order in liveConnections

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-framework-0.14.0.0-inplace" '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 LocalAddress #

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

Windows with `named-pipes`.

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

Protocol API

data NodeToClientProtocols (appType :: Mode) ntcAddr bytes (m :: Type -> Type) a b #

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

newtype MiniProtocolCb ctx bytes (m :: Type -> Type) a #

A callback executed by each muxed mini-protocol.

Constructors

MiniProtocolCb
Fields runMiniProtocolCb :: ctx -> Channel m bytes -> m (a, Maybe bytes)

data RunMiniProtocol (mode :: Mode) initiatorCtx responderCtx bytes (m :: Type -> Type) a b where #

RunMiniProtocol. It also capture context (the IsBigLedgerPeer) which is passed to the mini-protocol when a mini-protocol is started.

Constructors

InitiatorProtocolOnly :: forall initiatorCtx bytes (m :: Type -> Type) a responderCtx. MiniProtocolCb initiatorCtx bytes m a -> RunMiniProtocol 'InitiatorMode initiatorCtx responderCtx bytes m a Void
ResponderProtocolOnly :: forall responderCtx bytes (m :: Type -> Type) b initiatorCtx. MiniProtocolCb responderCtx bytes m b -> RunMiniProtocol 'ResponderMode initiatorCtx responderCtx bytes m Void b
InitiatorAndResponderProtocol :: forall initiatorCtx bytes (m :: Type -> Type) a responderCtx b. MiniProtocolCb initiatorCtx bytes m a -> MiniProtocolCb responderCtx bytes m b -> RunMiniProtocol 'InitiatorResponderMode initiatorCtx responderCtx bytes m a b

data ControlMessage #

Control signal sent to a mini-protocol. Expected to exit, on Continue it should continue its operation

Constructors

Continue	Continue operation.
Quiesce	Hold on, e.g. do not sent messages until resumed. This is not used for any hot protocol.
Terminate	The client is expected to terminate as soon as possible.

Instances

Instances details

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