Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Network

Contents

Types
Utility functions
Orphan instances

Description

Asynchronous messaging interface to the Hydra Network, e.g to other Hydra nodes.

Concrete implementations are provided by submodules. Import those instead of this one if interested in actually configuring and running a real network layer.

Incoming and outgoing messages are modelled as Message data type.

Synopsis

newtype Network m msg = Network {
- broadcast :: msg -> m ()
}
type NetworkComponent m inbound outbound a = NetworkCallback inbound m -> (Network m outbound -> m a) -> m a
type NetworkCallback msg m = msg -> m ()
data IP
data Host = Host {
- hostname :: Text
- port :: PortNumber
}
newtype NodeId = NodeId {
- nodeId :: Text
}
showHost :: Host -> String
readHost :: MonadFail m => String -> m Host
data PortNumber
readPort :: MonadFail m => String -> m PortNumber
close :: Socket -> IO ()

Types

newtype Network m msg Source #

Handle to interface with the hydra network and send messages "off chain".

Constructors

Network
Fields broadcast :: msg -> m () Send a `msg` to the whole hydra network.

Instances

Instances details

Contravariant (Network m) Source #
Instance details Defined in Hydra.Network Methods contramap :: (a' -> a) -> Network m a -> Network m a' Source # (>$) :: b -> Network m b -> Network m a Source #

type NetworkComponent m inbound outbound a = NetworkCallback inbound m -> (Network m outbound -> m a) -> m a Source #

A type tying both inbound and outbound messages sending in a single Component.

A NetworkComponent can have different inbound and outbound message types.

type NetworkCallback msg m = msg -> m () Source #

Handle to interface for inbound messages.

data IP #

Instances

Instances details

Arbitrary IP
Instance details Defined in Hydra.Options Methods arbitrary :: Gen IP shrink :: IP -> [IP]
FromJSON IP
Instance details Defined in Hydra.Network Methods parseJSON :: Value -> Parser IP parseJSONList :: Value -> Parser [IP] omittedField :: Maybe IP
ToJSON IP
Instance details Defined in Hydra.Network Methods toJSON :: IP -> Value toEncoding :: IP -> Encoding toJSONList :: [IP] -> Value toEncodingList :: [IP] -> Encoding omitField :: IP -> Bool
Data IP
Instance details Defined in Data.IP.Addr Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IP -> c IP Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IP Source # toConstr :: IP -> Constr Source # dataTypeOf :: IP -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c IP) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IP) Source # gmapT :: (forall b. Data b => b -> b) -> IP -> IP Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IP -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IP -> r Source # gmapQ :: (forall d. Data d => d -> u) -> IP -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> IP -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> IP -> m IP Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IP -> m IP Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IP -> m IP Source #
IsString IP
Instance details Defined in Data.IP.Addr Methods fromString :: String -> IP Source #
Enum IP
Instance details Defined in Data.IP.Addr Methods succ :: IP -> IP Source # pred :: IP -> IP Source # toEnum :: Int -> IP Source # fromEnum :: IP -> Int Source # enumFrom :: IP -> [IP] Source # enumFromThen :: IP -> IP -> [IP] Source # enumFromTo :: IP -> IP -> [IP] Source # enumFromThenTo :: IP -> IP -> IP -> [IP] Source #
Generic IP
Instance details Defined in Data.IP.Addr Associated Types type Rep IP :: Type -> Type Source # Methods from :: IP -> Rep IP x Source # to :: Rep IP x -> IP Source #
Read IP
Instance details Defined in Data.IP.Addr Methods readsPrec :: Int -> ReadS IP Source # readList :: ReadS [IP] Source # readPrec :: ReadPrec IP Source # readListPrec :: ReadPrec [IP] Source #
Show IP
Instance details Defined in Data.IP.Addr Methods showsPrec :: Int -> IP -> ShowS Source # show :: IP -> String Source # showList :: [IP] -> ShowS Source #
Eq IP
Instance details Defined in Data.IP.Addr Methods (==) :: IP -> IP -> Bool Source # (/=) :: IP -> IP -> Bool Source #
Ord IP
Instance details Defined in Data.IP.Addr Methods compare :: IP -> IP -> Ordering Source # (<) :: IP -> IP -> Bool Source # (<=) :: IP -> IP -> Bool Source # (>) :: IP -> IP -> Bool Source # (>=) :: IP -> IP -> Bool Source # max :: IP -> IP -> IP Source # min :: IP -> IP -> IP Source #
type Rep IP
Instance details Defined in Data.IP.Addr type Rep IP = D1 ('MetaData "IP" "Data.IP.Addr" "iproute-1.7.12-TaQxrVBVXULX9nRLa4fFM" 'False) (C1 ('MetaCons "IPv4" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipv4") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 IPv4)) :+: C1 ('MetaCons "IPv6" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipv6") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IPv6)))

data Host Source #

Constructors

Host
Fields hostname :: Text port :: PortNumber

Instances

Instances details

Arbitrary Host Source #
Instance details Defined in Hydra.Network Methods arbitrary :: Gen Host shrink :: Host -> [Host]
FromJSON Host Source #
Instance details Defined in Hydra.Network Methods parseJSON :: Value -> Parser Host parseJSONList :: Value -> Parser [Host] omittedField :: Maybe Host
ToJSON Host Source #
Instance details Defined in Hydra.Network Methods toJSON :: Host -> Value toEncoding :: Host -> Encoding toJSONList :: [Host] -> Value toEncodingList :: [Host] -> Encoding omitField :: Host -> Bool
Generic Host Source #
Instance details Defined in Hydra.Network Associated Types type Rep Host :: Type -> Type Source # Methods from :: Host -> Rep Host x Source # to :: Rep Host x -> Host Source #
Read Host Source #
Instance details Defined in Hydra.Network Methods readsPrec :: Int -> ReadS Host Source # readList :: ReadS [Host] Source # readPrec :: ReadPrec Host Source # readListPrec :: ReadPrec [Host] Source #
Show Host Source #
Instance details Defined in Hydra.Network Methods showsPrec :: Int -> Host -> ShowS Source # show :: Host -> String Source # showList :: [Host] -> ShowS Source #
FromCBOR Host Source #
Instance details Defined in Hydra.Network Methods fromCBOR :: Decoder s Host label :: Proxy Host -> Text
ToCBOR Host Source #
Instance details Defined in Hydra.Network Methods toCBOR :: Host -> Encoding encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy Host -> Size encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [Host] -> Size
Eq Host Source #
Instance details Defined in Hydra.Network Methods (==) :: Host -> Host -> Bool Source # (/=) :: Host -> Host -> Bool Source #
Ord Host Source #
Instance details Defined in Hydra.Network Methods compare :: Host -> Host -> Ordering Source # (<) :: Host -> Host -> Bool Source # (<=) :: Host -> Host -> Bool Source # (>) :: Host -> Host -> Bool Source # (>=) :: Host -> Host -> Bool Source # max :: Host -> Host -> Host Source # min :: Host -> Host -> Host Source #
type Rep Host Source #
Instance details Defined in Hydra.Network type Rep Host = D1 ('MetaData "Host" "Hydra.Network" "hydra-node-0.16.0-C0XGScKIquG5I6dPp21445" 'False) (C1 ('MetaCons "Host" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PortNumber)))

newtype NodeId Source #

Constructors

NodeId
Fields nodeId :: Text

Instances

Instances details

Arbitrary NodeId Source #
Instance details Defined in Hydra.Network Methods arbitrary :: Gen NodeId shrink :: NodeId -> [NodeId]
FromJSON NodeId Source #
Instance details Defined in Hydra.Network Methods parseJSON :: Value -> Parser NodeId parseJSONList :: Value -> Parser [NodeId] omittedField :: Maybe NodeId
ToJSON NodeId Source #
Instance details Defined in Hydra.Network Methods toJSON :: NodeId -> Value toEncoding :: NodeId -> Encoding toJSONList :: [NodeId] -> Value toEncodingList :: [NodeId] -> Encoding omitField :: NodeId -> Bool
IsString NodeId Source #
Instance details Defined in Hydra.Network Methods fromString :: String -> NodeId Source #
Read NodeId Source #
Instance details Defined in Hydra.Network Methods readsPrec :: Int -> ReadS NodeId Source # readList :: ReadS [NodeId] Source # readPrec :: ReadPrec NodeId Source # readListPrec :: ReadPrec [NodeId] Source #
Show NodeId Source #
Instance details Defined in Hydra.Network Methods showsPrec :: Int -> NodeId -> ShowS Source # show :: NodeId -> String Source # showList :: [NodeId] -> ShowS Source #
FromCBOR NodeId Source #
Instance details Defined in Hydra.Network Methods fromCBOR :: Decoder s NodeId label :: Proxy NodeId -> Text
ToCBOR NodeId Source #
Instance details Defined in Hydra.Network Methods toCBOR :: NodeId -> Encoding encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy NodeId -> Size encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [NodeId] -> Size
Eq NodeId Source #
Instance details Defined in Hydra.Network Methods (==) :: NodeId -> NodeId -> Bool Source # (/=) :: NodeId -> NodeId -> Bool Source #
Ord NodeId Source #
Instance details Defined in Hydra.Network Methods compare :: NodeId -> NodeId -> Ordering Source # (<) :: NodeId -> NodeId -> Bool Source # (<=) :: NodeId -> NodeId -> Bool Source # (>) :: NodeId -> NodeId -> Bool Source # (>=) :: NodeId -> NodeId -> Bool Source # max :: NodeId -> NodeId -> NodeId Source # min :: NodeId -> NodeId -> NodeId Source #

showHost :: Host -> String Source #

readHost :: MonadFail m => String -> m Host Source #

data PortNumber #

Instances

Instances details

Arbitrary PortNumber
Instance details Defined in Hydra.Network Methods arbitrary :: Gen PortNumber shrink :: PortNumber -> [PortNumber]
FromJSON PortNumber
Instance details Defined in Hydra.Network Methods parseJSON :: Value -> Parser PortNumber parseJSONList :: Value -> Parser [PortNumber] omittedField :: Maybe PortNumber
ToJSON PortNumber
Instance details Defined in Hydra.Network Methods toJSON :: PortNumber -> Value toEncoding :: PortNumber -> Encoding toJSONList :: [PortNumber] -> Value toEncodingList :: [PortNumber] -> Encoding omitField :: PortNumber -> Bool
Storable PortNumber
Instance details Defined in Network.Socket.Types Methods sizeOf :: PortNumber -> Int Source # alignment :: PortNumber -> Int Source # peekElemOff :: Ptr PortNumber -> Int -> IO PortNumber Source # pokeElemOff :: Ptr PortNumber -> Int -> PortNumber -> IO () Source # peekByteOff :: Ptr b -> Int -> IO PortNumber Source # pokeByteOff :: Ptr b -> Int -> PortNumber -> IO () Source # peek :: Ptr PortNumber -> IO PortNumber Source # poke :: Ptr PortNumber -> PortNumber -> IO () Source #
Bounded PortNumber
Instance details Defined in Network.Socket.Types Methods minBound :: PortNumber Source # maxBound :: PortNumber Source #
Enum PortNumber
Instance details Defined in Network.Socket.Types Methods succ :: PortNumber -> PortNumber Source # pred :: PortNumber -> PortNumber Source # toEnum :: Int -> PortNumber Source # fromEnum :: PortNumber -> Int Source # enumFrom :: PortNumber -> [PortNumber] Source # enumFromThen :: PortNumber -> PortNumber -> [PortNumber] Source # enumFromTo :: PortNumber -> PortNumber -> [PortNumber] Source # enumFromThenTo :: PortNumber -> PortNumber -> PortNumber -> [PortNumber] Source #
Num PortNumber
Instance details Defined in Network.Socket.Types Methods (+) :: PortNumber -> PortNumber -> PortNumber Source # (-) :: PortNumber -> PortNumber -> PortNumber Source # (*) :: PortNumber -> PortNumber -> PortNumber Source # negate :: PortNumber -> PortNumber Source # abs :: PortNumber -> PortNumber Source # signum :: PortNumber -> PortNumber Source # fromInteger :: Integer -> PortNumber Source #
Read PortNumber
Instance details Defined in Network.Socket.Types Methods readsPrec :: Int -> ReadS PortNumber Source # readList :: ReadS [PortNumber] Source # readPrec :: ReadPrec PortNumber Source # readListPrec :: ReadPrec [PortNumber] Source #
Integral PortNumber
Instance details Defined in Network.Socket.Types Methods quot :: PortNumber -> PortNumber -> PortNumber Source # rem :: PortNumber -> PortNumber -> PortNumber Source # div :: PortNumber -> PortNumber -> PortNumber Source # mod :: PortNumber -> PortNumber -> PortNumber Source # quotRem :: PortNumber -> PortNumber -> (PortNumber, PortNumber) Source # divMod :: PortNumber -> PortNumber -> (PortNumber, PortNumber) Source # toInteger :: PortNumber -> Integer Source #
Real PortNumber
Instance details Defined in Network.Socket.Types Methods toRational :: PortNumber -> Rational Source #
Show PortNumber
Instance details Defined in Network.Socket.Types Methods showsPrec :: Int -> PortNumber -> ShowS Source # show :: PortNumber -> String Source # showList :: [PortNumber] -> ShowS Source #
FromCBOR PortNumber
Instance details Defined in Hydra.Network Methods fromCBOR :: Decoder s PortNumber label :: Proxy PortNumber -> Text
ToCBOR PortNumber
Instance details Defined in Hydra.Network Methods toCBOR :: PortNumber -> Encoding encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy PortNumber -> Size encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [PortNumber] -> Size
Eq PortNumber
Instance details Defined in Network.Socket.Types Methods (==) :: PortNumber -> PortNumber -> Bool Source # (/=) :: PortNumber -> PortNumber -> Bool Source #
Ord PortNumber
Instance details Defined in Network.Socket.Types Methods compare :: PortNumber -> PortNumber -> Ordering Source # (<) :: PortNumber -> PortNumber -> Bool Source # (<=) :: PortNumber -> PortNumber -> Bool Source # (>) :: PortNumber -> PortNumber -> Bool Source # (>=) :: PortNumber -> PortNumber -> Bool Source # max :: PortNumber -> PortNumber -> PortNumber Source # min :: PortNumber -> PortNumber -> PortNumber Source #

readPort :: MonadFail m => String -> m PortNumber Source #

Utility functions

close :: Socket -> IO () #

Orphan instances

Arbitrary PortNumber Source #
Instance details Methods arbitrary :: Gen PortNumber shrink :: PortNumber -> [PortNumber]
FromJSON IP Source #
Instance details Methods parseJSON :: Value -> Parser IP parseJSONList :: Value -> Parser [IP] omittedField :: Maybe IP
FromJSON PortNumber Source #
Instance details Methods parseJSON :: Value -> Parser PortNumber parseJSONList :: Value -> Parser [PortNumber] omittedField :: Maybe PortNumber
ToJSON IP Source #
Instance details Methods toJSON :: IP -> Value toEncoding :: IP -> Encoding toJSONList :: [IP] -> Value toEncodingList :: [IP] -> Encoding omitField :: IP -> Bool
ToJSON PortNumber Source #
Instance details Methods toJSON :: PortNumber -> Value toEncoding :: PortNumber -> Encoding toJSONList :: [PortNumber] -> Value toEncodingList :: [PortNumber] -> Encoding omitField :: PortNumber -> Bool
FromCBOR PortNumber Source #
Instance details Methods fromCBOR :: Decoder s PortNumber label :: Proxy PortNumber -> Text
ToCBOR PortNumber Source #
Instance details Methods toCBOR :: PortNumber -> Encoding encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy PortNumber -> Size encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [PortNumber] -> Size