hydra-node-0.15.0: The Hydra node
Safe HaskellSafe-Inferred
LanguageGHC2021

Hydra.Network.Ouroboros

Description

Ouroboros-based implementation of Network interface. This implements a dumb FireForget protocol and maintains one connection to each peer. Contrary to other protocols implemented in Ouroboros, this is a push-based protocol.

Synopsis

Documentation

withOuroborosNetwork :: forall msg. (ToCBOR msg, FromCBOR msg) => Tracer IO (WithHost (TraceOuroborosNetwork msg)) -> Host -> [Host] -> NetworkComponent IO msg msg () Source #

withIOManager :: WithIOManager #

data TraceOuroborosNetwork msg Source #

Instances

Instances details
ToJSON msg => ToJSON (TraceOuroborosNetwork msg) Source # 
Instance details

Defined in Hydra.Network.Ouroboros

Methods

toJSON :: TraceOuroborosNetwork msg -> Value

toEncoding :: TraceOuroborosNetwork msg -> Encoding

toJSONList :: [TraceOuroborosNetwork msg] -> Value

toEncodingList :: [TraceOuroborosNetwork msg] -> Encoding

data WithHost trace Source #

Instances

Instances details
FromJSON trace => FromJSON (WithHost trace) Source # 
Instance details

Defined in Hydra.Network.Ouroboros

Methods

parseJSON :: Value -> Parser (WithHost trace)

parseJSONList :: Value -> Parser [WithHost trace]

ToJSON trace => ToJSON (WithHost trace) Source # 
Instance details

Defined in Hydra.Network.Ouroboros

Methods

toJSON :: WithHost trace -> Value

toEncoding :: WithHost trace -> Encoding

toJSONList :: [WithHost trace] -> Value

toEncodingList :: [WithHost trace] -> Encoding

Show trace => Show (WithHost trace) Source # 
Instance details

Defined in Hydra.Network.Ouroboros

Methods

showsPrec :: Int -> WithHost trace -> ShowS Source #

show :: WithHost trace -> String Source #

showList :: [WithHost trace] -> ShowS Source #

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

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 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.15.0-K4KH8u1blrnL9UtrBUWVZh" 'False) (C1 ('MetaCons "Host" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PortNumber)))

encodeTraceSendRecvFireForget :: forall msg. ToJSON msg => TraceSendRecv (FireForget msg) -> [Pair] Source #