Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.Protocol.Handshake.Type

Contents

Handshake Protocol

Synopsis

data Handshake vNumber vParams where
- StPropose ∷ Handshake vNumber vParams
- StConfirm ∷ Handshake vNumber vParams
- StDone ∷ Handshake vNumber vParams
data family Message ps (st ∷ ps) (st' ∷ ps)
data family ClientHasAgency (st ∷ ps)
data family ServerHasAgency (st ∷ ps)
data family NobodyHasAgency (st ∷ ps)
data RefuseReason vNumber
- = VersionMismatch [vNumber] [Int]
- | HandshakeDecodeError vNumber Text
- | Refused vNumber Text
data HandshakeProtocolError vNumber
- = HandshakeError (RefuseReason vNumber)
- | NotRecognisedVersion vNumber
- | InvalidServerSelection vNumber Text
- | QueryNotSupported
data HandshakeResult r vNumber vData
- = HandshakeNegotiationResult r vNumber vData
- | HandshakeQueryResult (Map vNumber (Either Text vData))

Handshake Protocol

data Handshake vNumber vParams where Source #

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

Constructors

StPropose ∷ Handshake vNumber vParams
StConfirm ∷ Handshake vNumber vParams
StDone ∷ Handshake vNumber vParams

Instances

Instances details

ShowProxy (Handshake vNumber vParams ∷ Type) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type Methods showProxy ∷ Proxy (Handshake vNumber vParams) → String Source #
Show (ClientHasAgency st) Source #
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) Source #
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) Source #
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) Source #
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 ∷ ∀ (st ∷ Handshake vNumber vParams). ClientHasAgency st → ServerHasAgency st → Void Source # exclusionLemma_NobodyAndClientHaveAgency ∷ ∀ (st ∷ Handshake vNumber vParams). NobodyHasAgency st → ClientHasAgency st → Void Source # exclusionLemma_NobodyAndServerHaveAgency ∷ ∀ (st ∷ Handshake vNumber vParams). NobodyHasAgency st → ServerHasAgency st → Void Source #
data ClientHasAgency (st ∷ Handshake vNumber vParams) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type data ClientHasAgency (st ∷ Handshake vNumber vParams) where TokPropose ∷ ∀ {k} {k} {vNumber ∷ k} {vParams ∷ k}. ClientHasAgency ('StPropose ∷ Handshake vNumber vParams)
data Message (Handshake vNumber vParams) (from ∷ Handshake vNumber vParams) (to ∷ Handshake vNumber vParams) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type data Message (Handshake vNumber vParams) (from ∷ Handshake vNumber vParams) (to ∷ Handshake vNumber vParams) where MsgProposeVersions ∷ ∀ vNumber vParams. Map vNumber vParams → Message (Handshake vNumber vParams) ('StPropose ∷ Handshake vNumber vParams) ('StConfirm ∷ Handshake vNumber vParams) MsgReplyVersions ∷ ∀ vNumber vParams. Map vNumber vParams → Message (Handshake vNumber vParams) ('StConfirm ∷ Handshake vNumber vParams) ('StDone ∷ Handshake vNumber vParams) MsgQueryReply ∷ ∀ vNumber vParams. Map vNumber vParams → Message (Handshake vNumber vParams) ('StConfirm ∷ Handshake vNumber vParams) ('StDone ∷ Handshake vNumber vParams) MsgAcceptVersion ∷ ∀ vNumber vParams. vNumber → vParams → Message (Handshake vNumber vParams) ('StConfirm ∷ Handshake vNumber vParams) ('StDone ∷ Handshake vNumber vParams) MsgRefuse ∷ ∀ {k} vNumber (vParams ∷ k). RefuseReason vNumber → Message (Handshake vNumber vParams) ('StConfirm ∷ Handshake vNumber vParams) ('StDone ∷ Handshake vNumber vParams)
data NobodyHasAgency (st ∷ Handshake vNumber vParams) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type data NobodyHasAgency (st ∷ Handshake vNumber vParams) where TokDone ∷ ∀ {k} {k} {vNumber ∷ k} {vParams ∷ k}. NobodyHasAgency ('StDone ∷ Handshake vNumber vParams)
data ServerHasAgency (st ∷ Handshake vNumber vParams) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type data ServerHasAgency (st ∷ Handshake vNumber vParams) where TokConfirm ∷ ∀ {k} {k} {vNumber ∷ k} {vParams ∷ k}. ServerHasAgency ('StConfirm ∷ Handshake vNumber vParams)

data family Message ps (st ∷ ps) (st' ∷ ps) Source #

The messages for this protocol. It is expected to be a GADT that is indexed by the from and to protocol states. That is the protocol state the message transitions from, and the protocol state it transitions into. These are the edges of the protocol state transition system.

Instances

Instances details

(Show vNumber, Show vParams) ⇒ Show (Message (Handshake vNumber vParams) from to) Source #
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 #
data Message (Handshake vNumber vParams) (from ∷ Handshake vNumber vParams) (to ∷ Handshake vNumber vParams) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type data Message (Handshake vNumber vParams) (from ∷ Handshake vNumber vParams) (to ∷ Handshake vNumber vParams) where MsgProposeVersions ∷ ∀ vNumber vParams. Map vNumber vParams → Message (Handshake vNumber vParams) ('StPropose ∷ Handshake vNumber vParams) ('StConfirm ∷ Handshake vNumber vParams) MsgReplyVersions ∷ ∀ vNumber vParams. Map vNumber vParams → Message (Handshake vNumber vParams) ('StConfirm ∷ Handshake vNumber vParams) ('StDone ∷ Handshake vNumber vParams) MsgQueryReply ∷ ∀ vNumber vParams. Map vNumber vParams → Message (Handshake vNumber vParams) ('StConfirm ∷ Handshake vNumber vParams) ('StDone ∷ Handshake vNumber vParams) MsgAcceptVersion ∷ ∀ vNumber vParams. vNumber → vParams → Message (Handshake vNumber vParams) ('StConfirm ∷ Handshake vNumber vParams) ('StDone ∷ Handshake vNumber vParams) MsgRefuse ∷ ∀ {k} vNumber (vParams ∷ k). RefuseReason vNumber → Message (Handshake vNumber vParams) ('StConfirm ∷ Handshake vNumber vParams) ('StDone ∷ Handshake vNumber vParams)

data family ClientHasAgency (st ∷ ps) Source #

Tokens for those protocol states in which the client has agency.

Instances

Instances details

Show (ClientHasAgency st) Source #
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 #
data ClientHasAgency (st ∷ Handshake vNumber vParams) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type data ClientHasAgency (st ∷ Handshake vNumber vParams) where TokPropose ∷ ∀ {k} {k} {vNumber ∷ k} {vParams ∷ k}. ClientHasAgency ('StPropose ∷ Handshake vNumber vParams)

data family ServerHasAgency (st ∷ ps) Source #

Tokens for those protocol states in which the server has agency.

Instances

Instances details

Show (ServerHasAgency st) Source #
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 #
data ServerHasAgency (st ∷ Handshake vNumber vParams) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type data ServerHasAgency (st ∷ Handshake vNumber vParams) where TokConfirm ∷ ∀ {k} {k} {vNumber ∷ k} {vParams ∷ k}. ServerHasAgency ('StConfirm ∷ Handshake vNumber vParams)

data family NobodyHasAgency (st ∷ ps) Source #

Tokens for terminal protocol states in which neither the client nor server has agency.

Instances

Instances details

data NobodyHasAgency (st ∷ Handshake vNumber vParams) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type data NobodyHasAgency (st ∷ Handshake vNumber vParams) where TokDone ∷ ∀ {k} {k} {vNumber ∷ k} {vParams ∷ k}. NobodyHasAgency ('StDone ∷ Handshake vNumber vParams)

On simultaneous open both sides will send MsgProposeVersions, which will be decoded as MsgReplyVersions. It is a terminal message of the protocol. It is important to stress that in this case both sides will make the choice which version and parameters to pick. Our algorithm for picking version is symmetric, which ensures that both sides will end up with the same choice. If one side decides to refuse the version it will close the connection, without sending the reason to the other side.

data RefuseReason vNumber Source #

Reasons by which a server can refuse proposed version.

Constructors

VersionMismatch [vNumber] [Int]	All of the prosed versions where not known to the server. Since the server sends all versions that it can knows about, some of them we might not be able to decode, so we include raw tags `[Int]`.
HandshakeDecodeError vNumber Text	The server failed to decode version parameters.
Refused vNumber Text	The server refused to run the proposed version parameters

Instances

Instances details

(Typeable vNumber, Show vNumber) ⇒ Exception (RefuseReason vNumber) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type Methods toException ∷ RefuseReason vNumber → SomeException Source # fromException ∷ SomeException → Maybe (RefuseReason vNumber) Source # displayException ∷ RefuseReason vNumber → String Source #
Show vNumber ⇒ Show (RefuseReason vNumber) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type Methods showsPrec ∷ Int → RefuseReason vNumber → ShowS Source # show ∷ RefuseReason vNumber → String Source # showList ∷ [RefuseReason vNumber] → ShowS Source #
Eq vNumber ⇒ Eq (RefuseReason vNumber) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type Methods (==) ∷ RefuseReason vNumber → RefuseReason vNumber → Bool Source # (/=) ∷ RefuseReason vNumber → RefuseReason vNumber → Bool Source #

data HandshakeProtocolError vNumber Source #

Extends handshake error RefuseReason type, by client specific errors.

Constructors

HandshakeError (RefuseReason vNumber)
NotRecognisedVersion vNumber
InvalidServerSelection vNumber Text
QueryNotSupported

Instances

Instances details

(Typeable vNumber, Show vNumber) ⇒ Exception (HandshakeProtocolError vNumber) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type Methods toException ∷ HandshakeProtocolError vNumber → SomeException Source # fromException ∷ SomeException → Maybe (HandshakeProtocolError vNumber) Source # displayException ∷ HandshakeProtocolError vNumber → String Source #
Show vNumber ⇒ Show (HandshakeProtocolError vNumber) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type Methods showsPrec ∷ Int → HandshakeProtocolError vNumber → ShowS Source # show ∷ HandshakeProtocolError vNumber → String Source # showList ∷ [HandshakeProtocolError vNumber] → ShowS Source #
Eq vNumber ⇒ Eq (HandshakeProtocolError vNumber) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Type Methods (==) ∷ HandshakeProtocolError vNumber → HandshakeProtocolError vNumber → Bool Source # (/=) ∷ HandshakeProtocolError vNumber → HandshakeProtocolError vNumber → Bool Source #

data HandshakeResult r vNumber vData Source #

The result of a handshake.

Constructors

HandshakeNegotiationResult r vNumber vData
HandshakeQueryResult (Map vNumber (Either Text vData))