Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Subscription

Contents

IP Subscription Worker
DNS Subscription Worker
Constants
Errors
Tracing

Description

Public interface of Subscription workers.

Synopsis

ipSubscriptionWorker :: forall a. Snocket IO Socket SockAddr -> Tracer IO ( WithIPList ( SubscriptionTrace SockAddr )) -> Tracer IO ( WithAddr SockAddr ErrorPolicyTrace ) -> NetworkMutableState SockAddr -> IPSubscriptionParams a -> ( Socket -> IO a) -> IO Void
data IPSubscriptionTarget = IPSubscriptionTarget {
- ispIps :: ![ SockAddr ]
- ispValency :: ! Int
}
dnsSubscriptionWorker :: Snocket IO Socket SockAddr -> Tracer IO ( WithDomainName ( SubscriptionTrace SockAddr )) -> Tracer IO ( WithDomainName DnsTrace ) -> Tracer IO ( WithAddr SockAddr ErrorPolicyTrace ) -> NetworkMutableState SockAddr -> DnsSubscriptionParams a -> ( Socket -> IO a) -> IO Void
data DnsSubscriptionTarget = DnsSubscriptionTarget {
- dstDomain :: ! Domain
- dstPort :: ! PortNumber
- dstValency :: ! Int
}
data ConnectResult
- = ConnectSuccess
- | ConnectSuccessLast
- | ConnectValencyExceeded
defaultConnectionAttemptDelay :: DiffTime
minConnectionAttemptDelay :: DiffTime
maxConnectionAttemptDelay :: DiffTime
ipRetryDelay :: DiffTime
resolutionDelay :: DiffTime
data SubscriberError = SubscriberError {
- seType :: !SubscriberErrorType
- seMessage :: ! String
- seStack :: ! CallStack
}
data SubscriptionTrace addr
- = SubscriptionTraceConnectStart addr
- | SubscriptionTraceConnectEnd addr ConnectResult
- | forall e. Exception e => SubscriptionTraceSocketAllocationException addr e
- | forall e. Exception e => SubscriptionTraceConnectException addr e
- | forall e. Exception e => SubscriptionTraceApplicationException addr e
- | SubscriptionTraceTryConnectToPeer addr
- | SubscriptionTraceSkippingPeer addr
- | SubscriptionTraceSubscriptionRunning
- | SubscriptionTraceSubscriptionWaiting Int
- | SubscriptionTraceSubscriptionFailed
- | SubscriptionTraceSubscriptionWaitingNewConnection DiffTime
- | SubscriptionTraceStart Int
- | SubscriptionTraceRestart DiffTime Int Int
- | SubscriptionTraceConnectionExist addr
- | SubscriptionTraceUnsupportedRemoteAddr addr
- | SubscriptionTraceMissingLocalAddress
- | SubscriptionTraceAllocateSocket addr
- | SubscriptionTraceCloseSocket addr
data WithIPList a = WithIPList {
- wilSrc :: LocalAddresses SockAddr
- wilDsts :: [ SockAddr ]
- wilEvent :: a
}
data DnsTrace
- = DnsTraceLookupException SomeException
- | DnsTraceLookupAError DNSError
- | DnsTraceLookupAAAAError DNSError
- | DnsTraceLookupIPv6First
- | DnsTraceLookupIPv4First
- | DnsTraceLookupAResult [ SockAddr ]
- | DnsTraceLookupAAAAResult [ SockAddr ]
data WithDomainName a = WithDomainName {
- wdnDomain :: Domain
- wdnEvent :: a
}

IP Subscription Worker

ipSubscriptionWorker :: forall a. Snocket IO Socket SockAddr -> Tracer IO ( WithIPList ( SubscriptionTrace SockAddr )) -> Tracer IO ( WithAddr SockAddr ErrorPolicyTrace ) -> NetworkMutableState SockAddr -> IPSubscriptionParams a -> ( Socket -> IO a) -> IO Void Source #

Spawns a subscription worker which will attempt to keep the specified number of connections (Valency) active towards the list of IP addresses given in IPSubscriptionTarget.

data IPSubscriptionTarget Source #

Constructors

IPSubscriptionTarget
Fields ispIps :: ![ SockAddr ] List of destinations to possibly connect to ispValency :: ! Int Number of parallel connections to keep actice.

Instances

Instances details

Eq IPSubscriptionTarget Source #
Instance details Defined in Ouroboros.Network.Subscription.Ip Methods (==) :: IPSubscriptionTarget -> IPSubscriptionTarget -> Bool Source # (/=) :: IPSubscriptionTarget -> IPSubscriptionTarget -> Bool Source #
Show IPSubscriptionTarget Source #
Instance details Defined in Ouroboros.Network.Subscription.Ip Methods showsPrec :: Int -> IPSubscriptionTarget -> ShowS Source # show :: IPSubscriptionTarget -> String Source # showList :: [ IPSubscriptionTarget ] -> ShowS Source #

DNS Subscription Worker

dnsSubscriptionWorker :: Snocket IO Socket SockAddr -> Tracer IO ( WithDomainName ( SubscriptionTrace SockAddr )) -> Tracer IO ( WithDomainName DnsTrace ) -> Tracer IO ( WithAddr SockAddr ErrorPolicyTrace ) -> NetworkMutableState SockAddr -> DnsSubscriptionParams a -> ( Socket -> IO a) -> IO Void Source #

data DnsSubscriptionTarget Source #

Constructors

DnsSubscriptionTarget
Fields dstDomain :: ! Domain dstPort :: ! PortNumber dstValency :: ! Int

Instances

Instances details

Eq DnsSubscriptionTarget Source #
Instance details Defined in Ouroboros.Network.Subscription.Dns Methods (==) :: DnsSubscriptionTarget -> DnsSubscriptionTarget -> Bool Source # (/=) :: DnsSubscriptionTarget -> DnsSubscriptionTarget -> Bool Source #
Show DnsSubscriptionTarget Source #
Instance details Defined in Ouroboros.Network.Subscription.Dns Methods showsPrec :: Int -> DnsSubscriptionTarget -> ShowS Source # show :: DnsSubscriptionTarget -> String Source # showList :: [ DnsSubscriptionTarget ] -> ShowS Source #

data ConnectResult Source #

GADT which classifies connection result.

Constructors

ConnectSuccess	Successful connection.
ConnectSuccessLast	Successfully connection, reached the valency target. Other ongoing connection attempts will be killed.
ConnectValencyExceeded	Someone else manged to create the final connection to a target before us.

Instances

Instances details

Eq ConnectResult Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods (==) :: ConnectResult -> ConnectResult -> Bool Source # (/=) :: ConnectResult -> ConnectResult -> Bool Source #
Ord ConnectResult Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods compare :: ConnectResult -> ConnectResult -> Ordering Source # (<) :: ConnectResult -> ConnectResult -> Bool Source # (<=) :: ConnectResult -> ConnectResult -> Bool Source # (>) :: ConnectResult -> ConnectResult -> Bool Source # (>=) :: ConnectResult -> ConnectResult -> Bool Source # max :: ConnectResult -> ConnectResult -> ConnectResult Source # min :: ConnectResult -> ConnectResult -> ConnectResult Source #
Show ConnectResult Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods showsPrec :: Int -> ConnectResult -> ShowS Source # show :: ConnectResult -> String Source # showList :: [ ConnectResult ] -> ShowS Source #

Constants

defaultConnectionAttemptDelay :: DiffTime Source #

Time to wait between connection attempts when we don't have any DeltaQ info.

minConnectionAttemptDelay :: DiffTime Source #

Minimum time to wait between connection attempts.

maxConnectionAttemptDelay :: DiffTime Source #

Maximum time to wait between connection attempts.

ipRetryDelay :: DiffTime Source #

Minimum time to wait between ip reconnects

resolutionDelay :: DiffTime Source #

Time to wait for an AAAA response after receiving an A response.

Errors

data SubscriberError Source #

Constructors

SubscriberError
Fields seType :: !SubscriberErrorType seMessage :: ! String seStack :: ! CallStack

Instances

Instances details

Show SubscriberError Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods showsPrec :: Int -> SubscriberError -> ShowS Source # show :: SubscriberError -> String Source # showList :: [ SubscriberError ] -> ShowS Source #
Exception SubscriberError Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods toException :: SubscriberError -> SomeException Source # fromException :: SomeException -> Maybe SubscriberError Source # displayException :: SubscriberError -> String Source #

Tracing

data SubscriptionTrace addr Source #

Constructors

SubscriptionTraceConnectStart addr
SubscriptionTraceConnectEnd addr ConnectResult
forall e. Exception e => SubscriptionTraceSocketAllocationException addr e
forall e. Exception e => SubscriptionTraceConnectException addr e
forall e. Exception e => SubscriptionTraceApplicationException addr e
SubscriptionTraceTryConnectToPeer addr
SubscriptionTraceSkippingPeer addr
SubscriptionTraceSubscriptionRunning
SubscriptionTraceSubscriptionWaiting Int
SubscriptionTraceSubscriptionFailed
SubscriptionTraceSubscriptionWaitingNewConnection DiffTime
SubscriptionTraceStart Int
SubscriptionTraceRestart DiffTime Int Int
SubscriptionTraceConnectionExist addr
SubscriptionTraceUnsupportedRemoteAddr addr
SubscriptionTraceMissingLocalAddress
SubscriptionTraceAllocateSocket addr
SubscriptionTraceCloseSocket addr

Instances

Instances details

Show addr => Show ( SubscriptionTrace addr) Source #
Instance details Defined in Ouroboros.Network.Subscription.Worker Methods showsPrec :: Int -> SubscriptionTrace addr -> ShowS Source # show :: SubscriptionTrace addr -> String Source # showList :: [ SubscriptionTrace addr] -> ShowS Source #

data WithIPList a Source #

Constructors

WithIPList
Fields wilSrc :: LocalAddresses SockAddr wilDsts :: [ SockAddr ] wilEvent :: a

Instances

Instances details

Show a => Show ( WithIPList a) Source #
Instance details Defined in Ouroboros.Network.Subscription.Ip Methods showsPrec :: Int -> WithIPList a -> ShowS Source # show :: WithIPList a -> String Source # showList :: [ WithIPList a] -> ShowS Source #

data DnsTrace Source #

Constructors

DnsTraceLookupException SomeException
DnsTraceLookupAError DNSError
DnsTraceLookupAAAAError DNSError
DnsTraceLookupIPv6First
DnsTraceLookupIPv4First
DnsTraceLookupAResult [ SockAddr ]
DnsTraceLookupAAAAResult [ SockAddr ]

Instances

Instances details

Show DnsTrace Source #
Instance details Defined in Ouroboros.Network.Subscription.Dns Methods showsPrec :: Int -> DnsTrace -> ShowS Source # show :: DnsTrace -> String Source # showList :: [ DnsTrace ] -> ShowS Source #

data WithDomainName a Source #

Constructors

WithDomainName
Fields wdnDomain :: Domain wdnEvent :: a

Instances

Instances details

Show a => Show ( WithDomainName a) Source #
Instance details Defined in Ouroboros.Network.Subscription.Dns Methods showsPrec :: Int -> WithDomainName a -> ShowS Source # show :: WithDomainName a -> String Source # showList :: [ WithDomainName a] -> ShowS Source #