ouroboros-network-framework-0.1.0.0
Safe HaskellSafe-Inferred
LanguageHaskell2010

Ouroboros.Network.Protocol.Handshake.Type

Synopsis

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 (ServerHasAgency st) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

Show (ClientHasAgency st) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

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

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

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

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 #

data NobodyHasAgency (st :: Handshake vNumber vParams) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

data NobodyHasAgency (st :: Handshake vNumber vParams) where
data ServerHasAgency (st :: Handshake vNumber vParams) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

data ServerHasAgency (st :: Handshake vNumber vParams) where
data ClientHasAgency (st :: Handshake vNumber vParams) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

data ClientHasAgency (st :: Handshake vNumber vParams) where
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

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 #

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

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

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

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

data ClientHasAgency (st :: Handshake vNumber vParams) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

data ClientHasAgency (st :: Handshake vNumber vParams) where

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

data ServerHasAgency (st :: Handshake vNumber vParams) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

data ServerHasAgency (st :: Handshake vNumber vParams) where

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

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
Eq vNumber => Eq (RefuseReason vNumber) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

Methods

(==) :: RefuseReason vNumber -> RefuseReason vNumber -> Bool #

(/=) :: RefuseReason vNumber -> RefuseReason vNumber -> Bool #

Show vNumber => Show (RefuseReason vNumber) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

Methods

showsPrec :: Int -> RefuseReason vNumber -> ShowS #

show :: RefuseReason vNumber -> String #

showList :: [RefuseReason vNumber] -> ShowS #

(Typeable vNumber, Show vNumber) => Exception (RefuseReason vNumber) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

data HandshakeClientProtocolError vNumber Source #

Client errors, which extends handshake error RefuseReason type, by client specific errors.