Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.Protocol.PeerSharing.Type

Synopsis

newtype PeerSharingAmount = PeerSharingAmount {
- getAmount ∷ Word8
}
data PeerSharingResult peerAddress
- = PeerSharingResult [peerAddress]
- | PeerSharingNotRegisteredYet
data PeerSharing peerAddress where
- StIdle ∷ PeerSharing peerAddress
- StBusy ∷ PeerSharing peerAddress
- StDone ∷ PeerSharing peerAddress

Documentation

newtype PeerSharingAmount Source #

PeerSharing amount new type.

We use Word8 to be faithful to the CDDL specification.

Constructors

PeerSharingAmount
Fields getAmount ∷ Word8

Instances

Instances details

Enum PeerSharingAmount Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods succ ∷ PeerSharingAmount → PeerSharingAmount # pred ∷ PeerSharingAmount → PeerSharingAmount # toEnum ∷ Int → PeerSharingAmount # fromEnum ∷ PeerSharingAmount → Int # enumFrom ∷ PeerSharingAmount → [PeerSharingAmount] # enumFromThen ∷ PeerSharingAmount → PeerSharingAmount → [PeerSharingAmount] # enumFromTo ∷ PeerSharingAmount → PeerSharingAmount → [PeerSharingAmount] # enumFromThenTo ∷ PeerSharingAmount → PeerSharingAmount → PeerSharingAmount → [PeerSharingAmount] #
Generic PeerSharingAmount Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Associated Types type Rep PeerSharingAmount ∷ Type → Type # Methods from ∷ PeerSharingAmount → Rep PeerSharingAmount x # to ∷ Rep PeerSharingAmount x → PeerSharingAmount #
Num PeerSharingAmount Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods (+) ∷ PeerSharingAmount → PeerSharingAmount → PeerSharingAmount # (-) ∷ PeerSharingAmount → PeerSharingAmount → PeerSharingAmount # (*) ∷ PeerSharingAmount → PeerSharingAmount → PeerSharingAmount # negate ∷ PeerSharingAmount → PeerSharingAmount # abs ∷ PeerSharingAmount → PeerSharingAmount # signum ∷ PeerSharingAmount → PeerSharingAmount # fromInteger ∷ Integer → PeerSharingAmount #
Integral PeerSharingAmount Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods quot ∷ PeerSharingAmount → PeerSharingAmount → PeerSharingAmount # rem ∷ PeerSharingAmount → PeerSharingAmount → PeerSharingAmount # div ∷ PeerSharingAmount → PeerSharingAmount → PeerSharingAmount # mod ∷ PeerSharingAmount → PeerSharingAmount → PeerSharingAmount # quotRem ∷ PeerSharingAmount → PeerSharingAmount → (PeerSharingAmount, PeerSharingAmount) # divMod ∷ PeerSharingAmount → PeerSharingAmount → (PeerSharingAmount, PeerSharingAmount) # toInteger ∷ PeerSharingAmount → Integer #
Real PeerSharingAmount Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods toRational ∷ PeerSharingAmount → Rational #
Show PeerSharingAmount Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods showsPrec ∷ Int → PeerSharingAmount → ShowS # show ∷ PeerSharingAmount → String # showList ∷ [PeerSharingAmount] → ShowS #
Eq PeerSharingAmount Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods (==) ∷ PeerSharingAmount → PeerSharingAmount → Bool # (/=) ∷ PeerSharingAmount → PeerSharingAmount → Bool #
Ord PeerSharingAmount Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods compare ∷ PeerSharingAmount → PeerSharingAmount → Ordering # (<) ∷ PeerSharingAmount → PeerSharingAmount → Bool # (<=) ∷ PeerSharingAmount → PeerSharingAmount → Bool # (>) ∷ PeerSharingAmount → PeerSharingAmount → Bool # (>=) ∷ PeerSharingAmount → PeerSharingAmount → Bool # max ∷ PeerSharingAmount → PeerSharingAmount → PeerSharingAmount # min ∷ PeerSharingAmount → PeerSharingAmount → PeerSharingAmount #
Serialise PeerSharingAmount Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods encode ∷ PeerSharingAmount → Encoding Source # decode ∷ Decoder s PeerSharingAmount Source # encodeList ∷ [PeerSharingAmount] → Encoding Source # decodeList ∷ Decoder s [PeerSharingAmount] Source #
type Rep PeerSharingAmount Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type type Rep PeerSharingAmount = D1 ('MetaData "PeerSharingAmount" "Ouroboros.Network.Protocol.PeerSharing.Type" "ouroboros-network-protocols-0.8.1.0-inplace" 'True) (C1 ('MetaCons "PeerSharingAmount" 'PrefixI 'True) (S1 ('MetaSel ('Just "getAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

data PeerSharingResult peerAddress Source #

PeerSharing Result type.

We need a constructor for the case when the Governor wins the race versus the Mux (when initialising the peer sharing miniprotocol). This leads the Governor to lookup a peer that hasn't been registered yet.

Constructors

PeerSharingResult [peerAddress]
PeerSharingNotRegisteredYet

Instances

Instances details

Show peerAddress ⇒ Show (PeerSharingResult peerAddress) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods showsPrec ∷ Int → PeerSharingResult peerAddress → ShowS # show ∷ PeerSharingResult peerAddress → String # showList ∷ [PeerSharingResult peerAddress] → ShowS #
Eq peerAddress ⇒ Eq (PeerSharingResult peerAddress) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods (==) ∷ PeerSharingResult peerAddress → PeerSharingResult peerAddress → Bool # (/=) ∷ PeerSharingResult peerAddress → PeerSharingResult peerAddress → Bool #

data PeerSharing peerAddress where Source #

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

Constructors

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

Instances

Instances details

ShowProxy (PeerSharing peer ∷ Type) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods showProxy ∷ Proxy (PeerSharing peer) → String Source #
Show peerAddress ⇒ Show (PeerSharing peerAddress) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods showsPrec ∷ Int → PeerSharing peerAddress → ShowS # show ∷ PeerSharing peerAddress → String # showList ∷ [PeerSharing peerAddress] → ShowS #
Show (ClientHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.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.PeerSharing.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.PeerSharing.Type Methods rnf ∷ ClientHasAgency st → () #
NFData (NobodyHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods rnf ∷ NobodyHasAgency st → () #
NFData (ServerHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods rnf ∷ ServerHasAgency st → () #
Eq peerAddress ⇒ Eq (PeerSharing peerAddress) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods (==) ∷ PeerSharing peerAddress → PeerSharing peerAddress → Bool # (/=) ∷ PeerSharing peerAddress → PeerSharing peerAddress → Bool #
Protocol (PeerSharing peerAddress) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Associated Types data Message (PeerSharing peerAddress) st st' Source # data ClientHasAgency st Source # data ServerHasAgency st Source # data NobodyHasAgency st Source # Methods exclusionLemma_ClientAndServerHaveAgency ∷ ∀ (st ∷ PeerSharing peerAddress). ClientHasAgency st → ServerHasAgency st → Void Source # exclusionLemma_NobodyAndClientHaveAgency ∷ ∀ (st ∷ PeerSharing peerAddress). NobodyHasAgency st → ClientHasAgency st → Void Source # exclusionLemma_NobodyAndServerHaveAgency ∷ ∀ (st ∷ PeerSharing peerAddress). NobodyHasAgency st → ServerHasAgency st → Void Source #
Show peer ⇒ Show (Message (PeerSharing peer) from to) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods showsPrec ∷ Int → Message (PeerSharing peer) from to → ShowS # show ∷ Message (PeerSharing peer) from to → String # showList ∷ [Message (PeerSharing peer) from to] → ShowS #
NFData peerAddress ⇒ NFData (Message (PeerSharing peerAddress) from to) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods rnf ∷ Message (PeerSharing peerAddress) from to → () #
NFData (PeerHasAgency pr st) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type Methods rnf ∷ PeerHasAgency pr st → () #
data ClientHasAgency (st ∷ PeerSharing peerAddress) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type data ClientHasAgency (st ∷ PeerSharing peerAddress) where TokIdle ∷ ∀ {k} {peerAddress ∷ k}. ClientHasAgency ('StIdle ∷ PeerSharing peerAddress)
data Message (PeerSharing peerAddress) (from ∷ PeerSharing peerAddress) (to ∷ PeerSharing peerAddress) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type data Message (PeerSharing peerAddress) (from ∷ PeerSharing peerAddress) (to ∷ PeerSharing peerAddress) where MsgShareRequest ∷ ∀ {k} (peerAddress ∷ k). PeerSharingAmount → Message (PeerSharing peerAddress) ('StIdle ∷ PeerSharing peerAddress) ('StBusy ∷ PeerSharing peerAddress) MsgSharePeers ∷ ∀ peerAddress1. [peerAddress1] → Message (PeerSharing peerAddress1) ('StBusy ∷ PeerSharing peerAddress1) ('StIdle ∷ PeerSharing peerAddress1) MsgDone ∷ ∀ {k} (peerAddress ∷ k). Message (PeerSharing peerAddress) ('StIdle ∷ PeerSharing peerAddress) ('StDone ∷ PeerSharing peerAddress)
data NobodyHasAgency (st ∷ PeerSharing peerAddress) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type data NobodyHasAgency (st ∷ PeerSharing peerAddress) where TokDone ∷ ∀ {k} {peerAddress ∷ k}. NobodyHasAgency ('StDone ∷ PeerSharing peerAddress)
data ServerHasAgency (st ∷ PeerSharing peerAddress) Source #
Instance details Defined in Ouroboros.Network.Protocol.PeerSharing.Type data ServerHasAgency (st ∷ PeerSharing peerAddress) where TokBusy ∷ ∀ {k} {peerAddress ∷ k}. ServerHasAgency ('StBusy ∷ PeerSharing peerAddress)