cardano-client-0.1.0.0: An API for ouroboros-network
Safe HaskellNone
LanguageHaskell2010

Cardano.Client.Subscription

Synopsis

Documentation

type ClientCodecs blk (m ∷ TypeType) = Codecs' blk blk DeserialiseFailure m ByteString ByteString ByteString ByteString Source #

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.

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

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

maxConnectionId addr → ConnectionId addr → ConnectionId addr Source #

minConnectionId addr → ConnectionId addr → ConnectionId addr Source #

Show addr ⇒ Show (ConnectionId addr) 
Instance details

Defined in Ouroboros.Network.ConnectionId

Methods

showsPrecIntConnectionId addr → ShowS Source #

showConnectionId addr → String Source #

showList ∷ [ConnectionId addr] → ShowS Source #

Generic (ConnectionId addr) 
Instance details

Defined in Ouroboros.Network.ConnectionId

Associated Types

type Rep (ConnectionId addr) ∷ TypeType Source #

Methods

fromConnectionId addr → Rep (ConnectionId addr) x Source #

toRep (ConnectionId addr) x → ConnectionId addr Source #

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

showTypeOfProxy (ConnectionId addr) → String #

Hashable a ⇒ Hashable (ConnectionId a) 
Instance details

Defined in Ouroboros.Network.ConnectionId

Methods

hashWithSaltIntConnectionId a → Int

hashConnectionId a → Int

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

data LocalAddress Source #

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

Windows with `named-pipes`.

Instances

Instances details
Eq LocalAddress 
Instance details

Defined in Ouroboros.Network.Snocket

Ord LocalAddress 
Instance details

Defined in Ouroboros.Network.Snocket

Show LocalAddress 
Instance details

Defined in Ouroboros.Network.Snocket

Generic LocalAddress 
Instance details

Defined in Ouroboros.Network.Snocket

Associated Types

type Rep LocalAddressTypeType Source #

Hashable LocalAddress 
Instance details

Defined in Ouroboros.Network.Snocket

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

data NodeToClientProtocols (appType ∷ MuxMode) bytes (m ∷ TypeType) a b Source #

Recorod of node-to-client mini protocols.

Constructors

NodeToClientProtocols 

Fields

data MuxPeer bytes (m ∷ TypeType) a where Source #

Constructors

MuxPeer ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps) failure bytes (m ∷ TypeType) a. (Show failure, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ Tracer m (TraceSendRecv ps) → Codec ps failure m bytes → Peer ps pr st m a → MuxPeer bytes m a 
MuxPeerPipelined ∷ ∀ (pr ∷ PeerRole) ps (st ∷ ps) failure bytes (m ∷ TypeType) a. (Show failure, ∀ (st' ∷ ps). Show (ClientHasAgency st'), ∀ (st' ∷ ps). Show (ServerHasAgency st'), ShowProxy ps) ⇒ Tracer m (TraceSendRecv ps) → Codec ps failure m bytes → PeerPipelined ps pr st m a → MuxPeer bytes m a 
MuxPeerRaw ∷ ∀ (m ∷ TypeType) bytes a. (Channel m bytes → m (a, Maybe bytes)) → MuxPeer bytes m a 

data MuxTrace Source #

Enumeration of Mux events that can be traced.

Instances

Instances details
Show MuxTrace 
Instance details

Defined in Network.Mux.Trace

data RunMiniProtocol (mode ∷ MuxMode) bytes (m ∷ TypeType) a b where Source #

Constructors

InitiatorProtocolOnly ∷ ∀ bytes (m ∷ TypeType) a. MuxPeer bytes m a → RunMiniProtocol 'InitiatorMode bytes m a Void 
ResponderProtocolOnly ∷ ∀ bytes (m ∷ TypeType) b. MuxPeer bytes m b → RunMiniProtocol 'ResponderMode bytes m Void b 
InitiatorAndResponderProtocol ∷ ∀ bytes (m ∷ TypeType) a b. MuxPeer bytes m a → MuxPeer bytes m b → RunMiniProtocol 'InitiatorResponderMode bytes m a b 

data WithMuxBearer peerid a Source #

Type used for tracing mux events.

Instances

Instances details
(Show peerid, Show a) ⇒ Show (WithMuxBearer peerid a) 
Instance details

Defined in Network.Mux.Trace

Methods

showsPrecIntWithMuxBearer peerid a → ShowS Source #

showWithMuxBearer peerid a → String Source #

showList ∷ [WithMuxBearer peerid a] → ShowS Source #

Generic (WithMuxBearer peerid a) 
Instance details

Defined in Network.Mux.Trace

Associated Types

type Rep (WithMuxBearer peerid a) ∷ TypeType Source #

Methods

fromWithMuxBearer peerid a → Rep (WithMuxBearer peerid a) x Source #

toRep (WithMuxBearer peerid a) x → WithMuxBearer peerid a Source #

type Rep (WithMuxBearer peerid a) 
Instance details

Defined in Network.Mux.Trace

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

data ControlMessage Source #

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
Eq ControlMessage 
Instance details

Defined in Ouroboros.Network.Mux

Show ControlMessage 
Instance details

Defined in Ouroboros.Network.Mux

cChainSyncCodecCodecs' blk serialisedBlk e m bCS bTX bSQ bTM → Codec (ChainSync serialisedBlk (Point blk) (Tip blk)) e m bCS Source #

cStateQueryCodecCodecs' blk serialisedBlk e m bCS bTX bSQ bTM → Codec (LocalStateQuery blk (Point blk) (Query blk)) e m bSQ Source #

cTxSubmissionCodecCodecs' blk serialisedBlk e m bCS bTX bSQ bTM → Codec (LocalTxSubmission (GenTx blk) (ApplyTxErr blk)) e m bTX Source #