hydra-node-0.13.0: The Hydra node
Safe HaskellSafe-Inferred
LanguageHaskell2010

Hydra.Network

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

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 msg a = NetworkCallback msg m -> (Network m msg -> m a) -> m a Source #

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

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

Handle to interface for inbound messages.

data IP #

Instances

Instances details
FromJSON IP 
Instance details

Defined in Hydra.Network

Methods

parseJSON :: Value -> Parser IP

parseJSONList :: Value -> Parser [IP]

ToJSON IP 
Instance details

Defined in Hydra.Network

Methods

toJSON :: IP -> Value

toEncoding :: IP -> Encoding

toJSONList :: [IP] -> Value

toEncodingList :: [IP] -> Encoding

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

Show IP 
Instance details

Defined in Data.IP.Addr

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-2LK7CISbMY4KTLEVrIHzRT" '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

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]

ToJSON Host Source # 
Instance details

Defined in Hydra.Network

Methods

toJSON :: Host -> Value

toEncoding :: Host -> Encoding

toJSONList :: [Host] -> Value

toEncodingList :: [Host] -> Encoding

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

Show Host Source # 
Instance details

Defined in Hydra.Network

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

type Rep Host Source # 
Instance details

Defined in Hydra.Network

type Rep Host = D1 ('MetaData "Host" "Hydra.Network" "hydra-node-0.13.0-HKlbaPrFKjs2dhEMwn7ono" '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

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]

ToJSON NodeId Source # 
Instance details

Defined in Hydra.Network

Methods

toJSON :: NodeId -> Value

toEncoding :: NodeId -> Encoding

toJSONList :: [NodeId] -> Value

toEncodingList :: [NodeId] -> Encoding

IsString NodeId Source # 
Instance details

Defined in Hydra.Network

Read NodeId Source # 
Instance details

Defined in Hydra.Network

Show NodeId Source # 
Instance details

Defined in Hydra.Network

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

Ord NodeId Source # 
Instance details

Defined in Hydra.Network

data PortNumber #

Instances

Instances details
Arbitrary PortNumber 
Instance details

Defined in Hydra.Network

FromJSON PortNumber 
Instance details

Defined in Hydra.Network

Methods

parseJSON :: Value -> Parser PortNumber

parseJSONList :: Value -> Parser [PortNumber]

ToJSON PortNumber 
Instance details

Defined in Hydra.Network

Methods

toJSON :: PortNumber -> Value

toEncoding :: PortNumber -> Encoding

toJSONList :: [PortNumber] -> Value

toEncodingList :: [PortNumber] -> Encoding

Storable PortNumber 
Instance details

Defined in Network.Socket.Types

Bounded PortNumber 
Instance details

Defined in Network.Socket.Types

Enum PortNumber 
Instance details

Defined in Network.Socket.Types

Num PortNumber 
Instance details

Defined in Network.Socket.Types

Read PortNumber 
Instance details

Defined in Network.Socket.Types

Integral PortNumber 
Instance details

Defined in Network.Socket.Types

Real PortNumber 
Instance details

Defined in Network.Socket.Types

Show PortNumber 
Instance details

Defined in Network.Socket.Types

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

Ord PortNumber 
Instance details

Defined in Network.Socket.Types

Utility functions

close :: Socket -> IO () #

Orphan instances

Arbitrary PortNumber Source # 
Instance details

FromJSON IP Source # 
Instance details

Methods

parseJSON :: Value -> Parser IP

parseJSONList :: Value -> Parser [IP]

FromJSON PortNumber Source # 
Instance details

Methods

parseJSON :: Value -> Parser PortNumber

parseJSONList :: Value -> Parser [PortNumber]

ToJSON IP Source # 
Instance details

Methods

toJSON :: IP -> Value

toEncoding :: IP -> Encoding

toJSONList :: [IP] -> Value

toEncodingList :: [IP] -> Encoding

ToJSON PortNumber Source # 
Instance details

Methods

toJSON :: PortNumber -> Value

toEncoding :: PortNumber -> Encoding

toJSONList :: [PortNumber] -> Value

toEncodingList :: [PortNumber] -> Encoding

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