Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.Protocol.KeepAlive.Type

Description

The type of the keep alive protocol.

The keep alive protocol is used for

sending keep alive messages
making round trip measuremnets

Each side will run its own version of the keep alive protocol. It should be configured so that any intermediate state (such as in customer premise equipment or in a carrier grade NAT) is kept alive. This has to be a per-node configuration element as this is about the properties of that nodes network connectivity.

For making round trip measurements its in the interest of the other side to reply promptly.

Synopsis

newtype Cookie = Cookie {
- unCookie ∷ Word16
}
data KeepAliveProtocolFailure = KeepAliveCookieMissmatch Cookie Cookie
data KeepAlive where
- StClient ∷ KeepAlive
- StServer ∷ KeepAlive
- StDone ∷ KeepAlive

Documentation

newtype Cookie Source #

A 16bit value used to match responses to requests.

Constructors

Cookie
Fields unCookie ∷ Word16

Instances

data KeepAliveProtocolFailure Source #

Constructors

KeepAliveCookieMissmatch Cookie Cookie

Instances

Instances details

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

data KeepAlive where Source #

A kind to identify our protocol, and the types of the states in the state transition diagram of the protocol.

Constructors

StClient ∷ KeepAlive	The client can send a request and the server is waiting for a request.
StServer ∷ KeepAlive	The server is responsible for sending response back.
StDone ∷ KeepAlive	Both the client and server are in the terminal state. They're done.

Instances

Instances details

Protocol KeepAlive Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Associated Types data Message KeepAlive st st' Source # data ClientHasAgency st Source # data ServerHasAgency st Source # data NobodyHasAgency st Source # Methods exclusionLemma_ClientAndServerHaveAgency ∷ ∀ (st ∷ KeepAlive). ClientHasAgency st → ServerHasAgency st → Void Source # exclusionLemma_NobodyAndClientHaveAgency ∷ ∀ (st ∷ KeepAlive). NobodyHasAgency st → ClientHasAgency st → Void Source # exclusionLemma_NobodyAndServerHaveAgency ∷ ∀ (st ∷ KeepAlive). NobodyHasAgency st → ServerHasAgency st → Void Source #
ShowProxy KeepAlive Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Methods showProxy ∷ Proxy KeepAlive → String Source #
Show (ClientHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Methods showsPrec ∷ Int → ClientHasAgency st → ShowS # show ∷ ClientHasAgency st → String # showList ∷ [ClientHasAgency st] → ShowS #
Show (ServerHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Methods showsPrec ∷ Int → ServerHasAgency st → ShowS # show ∷ ServerHasAgency st → String # showList ∷ [ServerHasAgency st] → ShowS #
NFData (ClientHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Methods rnf ∷ ClientHasAgency st → () #
NFData (NobodyHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Methods rnf ∷ NobodyHasAgency st → () #
NFData (ServerHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Methods rnf ∷ ServerHasAgency st → () #
Show (Message KeepAlive from to) Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Methods showsPrec ∷ Int → Message KeepAlive from to → ShowS # show ∷ Message KeepAlive from to → String # showList ∷ [Message KeepAlive from to] → ShowS #
NFData (Message KeepAlive from to) Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Methods rnf ∷ Message KeepAlive from to → () #
NFData (PeerHasAgency pr st) Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Methods rnf ∷ PeerHasAgency pr st → () #
data ClientHasAgency (st ∷ KeepAlive) Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type data ClientHasAgency (st ∷ KeepAlive) where TokClient ∷ ClientHasAgency 'StClient
data Message KeepAlive (from ∷ KeepAlive) (to ∷ KeepAlive) Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type data Message KeepAlive (from ∷ KeepAlive) (to ∷ KeepAlive) where MsgKeepAlive ∷ Cookie → Message KeepAlive 'StClient 'StServer MsgKeepAliveResponse ∷ Cookie → Message KeepAlive 'StServer 'StClient MsgDone ∷ Message KeepAlive 'StClient 'StDone
data NobodyHasAgency (st ∷ KeepAlive) Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type data NobodyHasAgency (st ∷ KeepAlive) where TokDone ∷ NobodyHasAgency 'StDone
data ServerHasAgency (st ∷ KeepAlive) Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type data ServerHasAgency (st ∷ KeepAlive) where TokServer ∷ ServerHasAgency 'StServer

Generic Cookie Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Associated Types type Rep Cookie ∷ Type → Type # Methods from ∷ Cookie → Rep Cookie x # to ∷ Rep Cookie x → Cookie #
Show Cookie Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Methods showsPrec ∷ Int → Cookie → ShowS # show ∷ Cookie → String # showList ∷ [Cookie] → ShowS #
NFData Cookie Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Methods rnf ∷ Cookie → () #
Eq Cookie Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type Methods (==) ∷ Cookie → Cookie → Bool # (/=) ∷ Cookie → Cookie → Bool #
type Rep Cookie Source #
Instance details Defined in Ouroboros.Network.Protocol.KeepAlive.Type type Rep Cookie = D1 ('MetaData "Cookie" "Ouroboros.Network.Protocol.KeepAlive.Type" "ouroboros-network-protocols-0.8.1.0-inplace" 'True) (C1 ('MetaCons "Cookie" 'PrefixI 'True) (S1 ('MetaSel ('Just "unCookie") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))