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)
}
newtype Application vData r = Application {
- runApplication :: vData -> r
}
data Version vData r = Version {
- versionApplication :: Application 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 set of versions supported by the local agent are described by a map keyed on the version identifier.

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 #

newtype Application vData r Source #

Takes a pair of version data: local then remote.

Constructors

Application
Fields runApplication :: vData -> r

Instances

Instances details

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

data Version vData r Source #

Constructors

Version
Fields versionApplication :: Application 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 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 # (/=) :: Accept vData -> Accept vData -> Bool #
Show vData => Show (Accept vData) Source #
Instance details Defined in Ouroboros.Network.Protocol.Handshake.Version Methods showsPrec :: Int -> Accept vData -> ShowS # show :: Accept vData -> String # showList :: [Accept vData] -> ShowS #

class Acceptable v where Source #

Methods

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

Instances

Instances details

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 #