Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Protocol.Handshake.Version

Contents

Simple or no versioning

Synopsis

newtype Versions vNum vData r = Versions {
- getVersions :: Map vNum ( Version vData r)
}
data Version vData r = Version {
- versionApplication :: vData -> r
- versionData :: vData
}
data Accept vData
- = Accept vData
- | Refuse ! Text
class Acceptable v where
- acceptableVersion :: v -> v -> Accept v
data VersionMismatch vNum where
- NoCommonVersion :: VersionMismatch vNum
- InconsistentVersion :: vNum -> VersionMismatch vNum
simpleSingletonVersions :: vNum -> 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

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 Source # (<$) :: a -> Versions vNum extra b -> Versions vNum extra a Source #
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 Source # sconcat :: NonEmpty ( Versions vNum vData r) -> Versions vNum vData r Source # stimes :: Integral b => b -> 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 Source # (<$) :: a -> Version vData b -> Version vData a Source #

data Accept vData Source #

A Maybe like type which better explains its purpose.

Constructors

Accept vData
Refuse ! Text

Instances

Instances details

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

class Acceptable v where Source #

Methods

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

Instances

Instances details

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

data VersionMismatch vNum where Source #

Constructors

NoCommonVersion :: VersionMismatch vNum
InconsistentVersion :: vNum -> VersionMismatch vNum

Simple or no versioning

simpleSingletonVersions :: vNum -> vData -> r -> Versions vNum vData r Source #

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 #