ouroboros-network:protocols
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Network.Protocol.PeerSharing.Type

Synopsis

Documentation

newtype PeerSharingAmount Source #

PeerSharing amount new type.

We use Word8 to be faithful to the CDDL specification.

Constructors

PeerSharingAmount 

Fields

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

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

type Rep PeerSharingAmount = D1 ('MetaData "PeerSharingAmount" "Ouroboros.Network.Protocol.PeerSharing.Type" "ouroboros-network-0.23.0.0-inplace-protocols" 'True) (C1 ('MetaCons "PeerSharingAmount" 'PrefixI 'True) (S1 ('MetaSel ('Just "getAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

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 #

decode :: Decoder s PeerSharingAmount #

encodeList :: [PeerSharingAmount] -> Encoding #

decodeList :: Decoder s [PeerSharingAmount] #

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-0.23.0.0-inplace-protocols" '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 :: forall peerAddress. PeerSharing peerAddress

The client can send a request and the server is waiting for a request.

StBusy :: forall peerAddress. PeerSharing peerAddress

The server is responsible for sending response back.

StDone :: forall peerAddress. 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

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 #

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

type StateToken 
Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

type StateToken = SingPeerSharing :: PeerSharing peerAddress -> Type
StateTokenI ('StBusy :: PeerSharing peerAddress) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

Methods

stateToken :: StateToken ('StBusy :: PeerSharing peerAddress) #

StateTokenI ('StDone :: PeerSharing peerAddress) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

Methods

stateToken :: StateToken ('StDone :: PeerSharing peerAddress) #

StateTokenI ('StIdle :: PeerSharing peerAddress) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

Methods

stateToken :: StateToken ('StIdle :: PeerSharing peerAddress) #

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

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 #

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
type StateToken Source # 
Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

type StateToken = SingPeerSharing :: PeerSharing peerAddress -> Type
type StateAgency ('StBusy :: PeerSharing peerAddress) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

type StateAgency ('StBusy :: PeerSharing peerAddress) = 'ServerAgency
type StateAgency ('StDone :: PeerSharing peerAddress) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

type StateAgency ('StDone :: PeerSharing peerAddress) = 'NobodyAgency
type StateAgency ('StIdle :: PeerSharing peerAddress) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

type StateAgency ('StIdle :: PeerSharing peerAddress) = 'ClientAgency

data SingPeerSharing (k :: PeerSharing peerAddress) where Source #

Constructors

SingIdle :: forall {peerAddress}. SingPeerSharing ('StIdle :: PeerSharing peerAddress) 
SingBusy :: forall {peerAddress}. SingPeerSharing ('StBusy :: PeerSharing peerAddress) 
SingDone :: forall {peerAddress}. SingPeerSharing ('StDone :: PeerSharing peerAddress) 

Instances

Instances details
Show (SingPeerSharing peerAddress2) Source # 
Instance details

Defined in Ouroboros.Network.Protocol.PeerSharing.Type

Methods

showsPrec :: Int -> SingPeerSharing peerAddress2 -> ShowS #

show :: SingPeerSharing peerAddress2 -> String #

showList :: [SingPeerSharing peerAddress2] -> ShowS #