Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Protocol.Handshake.Version

Contents

Simple or no versioning
Re-exports

Synopsis

newtype Versions vNum vData r = Versions {
- getVersions :: Map vNum (Version vData r)
}
updateVersionData :: (vData -> vData) -> Versions vNum vData r -> Versions vNum vData r
data Version vData r = Version {
- versionApplication :: vData -> r
- versionData :: vData
}
data VersionMismatch vNum where
- NoCommonVersion :: forall vNum. VersionMismatch vNum
- InconsistentVersion :: forall vNum. vNum -> VersionMismatch vNum
simpleSingletonVersions :: vNum -> vData -> (vData -> r) -> Versions vNum vData r
foldMapVersions :: (Ord vNum, Foldable f, HasCallStack) => (x -> Versions vNum extra r) -> f x -> Versions vNum extra r
combineVersions :: (Ord vNum, Foldable f, HasCallStack) => f (Versions vNum extra r) -> Versions vNum extra r
data Accept vData
- = Accept vData
- | Refuse !Text
class Acceptable v where
- acceptableVersion :: v -> v -> Accept v
class Queryable v where
- queryVersion :: v -> Bool

Documentation

newtype Versions vNum vData r Source #

The version map supported by the local agent keyed on the version identifier.

Each Version contains a function which takes negotiated version data and returns negotiated application (the r type variable).

If one needs to combine multiple versions the simplest way is to use one of the combinators: foldMapVersions, combineVersions or the Semigroup instance directly:

fold $ (simpleSingletonVersions ...)
      :| [ (simpleSingletonVersions ...)
         , (simpleSingletonVersions ...)
         , ...
         ]

Constructors

Versions
Fields getVersions :: Map vNum (Version vData r)

Instances

Instances details

Functor (Versions vNum extra) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Version Methods fmap :: (a -> b) -> Versions vNum extra a -> Versions vNum extra b # (<$) :: a -> Versions vNum extra b -> Versions vNum extra a #
Ord vNum => Semigroup (Versions vNum vData r) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Version Methods (<>) :: Versions vNum vData r -> Versions vNum vData r -> Versions vNum vData r # sconcat :: NonEmpty (Versions vNum vData r) -> Versions vNum vData r # stimes :: Integral b => b -> Versions vNum vData r -> Versions vNum vData r #

updateVersionData :: (vData -> vData) -> Versions vNum vData r -> Versions vNum vData r Source #

data Version vData r Source #

Constructors

Version
Fields versionApplication :: vData -> r versionData :: vData

Instances

Instances details

Functor (Version vData) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Version Methods fmap :: (a -> b) -> Version vData a -> Version vData b # (<$) :: a -> Version vData b -> Version vData a #

data VersionMismatch vNum where Source #

Constructors

NoCommonVersion :: forall vNum. VersionMismatch vNum
InconsistentVersion :: forall vNum. vNum -> VersionMismatch vNum

Simple or no versioning

simpleSingletonVersions Source #

Arguments

:: vNum	version number
-> vData	proposed version data
-> (vData -> r)	callback which receives negotiated version data
-> Versions vNum vData r

Singleton smart constructor for Versions.

foldMapVersions :: (Ord vNum, Foldable f, HasCallStack) => (x -> Versions vNum extra r) -> f x -> Versions vNum extra r Source #

Useful for folding multiple Versions.

A foldMap restricted to the Versions Semigroup.

PRECONDITION: f x is non-empty.

combineVersions :: (Ord vNum, Foldable f, HasCallStack) => f (Versions vNum extra r) -> Versions vNum extra r Source #

Re-exports

data Accept vData #

A Maybe like type which better explains its purpose.

Constructors

Accept vData
Refuse !Text

Instances

Instances details

Show vData => Show (Accept vData)
Instance details Defined in Ouroboros.Network.Handshake.Acceptable Methods showsPrec :: Int -> Accept vData -> ShowS # show :: Accept vData -> String # showList :: [Accept vData] -> ShowS #
Eq vData => Eq (Accept vData)
Instance details Defined in Ouroboros.Network.Handshake.Acceptable Methods (==) :: Accept vData -> Accept vData -> Bool # (/=) :: Accept vData -> Accept vData -> Bool #

class Acceptable v where #

Methods

acceptableVersion :: v -> v -> Accept v #

The acceptableVersion function ought to be symmetric, this guarantees that local and remote sides will agree on the same data.

Instances

Instances details

Acceptable NodeToClientVersionData
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods acceptableVersion :: NodeToClientVersionData -> NodeToClientVersionData -> Accept NodeToClientVersionData #
Acceptable NodeToNodeVersionData
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods acceptableVersion :: NodeToNodeVersionData -> NodeToNodeVersionData -> Accept NodeToNodeVersionData #
Acceptable DataFlowProtocolData Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Unversioned Methods acceptableVersion :: DataFlowProtocolData -> DataFlowProtocolData -> Accept DataFlowProtocolData #
Acceptable UnversionedProtocolData Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Unversioned Methods acceptableVersion :: UnversionedProtocolData -> UnversionedProtocolData -> Accept UnversionedProtocolData #

class Queryable v where #

Methods

queryVersion :: v -> Bool #

Whether or not there was a query for the supported version.

Instances

Instances details

Queryable NodeToClientVersionData
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods queryVersion :: NodeToClientVersionData -> Bool #
Queryable NodeToNodeVersionData
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods queryVersion :: NodeToNodeVersionData -> Bool #
Queryable DataFlowProtocolData Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Unversioned Methods queryVersion :: DataFlowProtocolData -> Bool #
Queryable UnversionedProtocolData Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Unversioned Methods queryVersion :: UnversionedProtocolData -> Bool #