Safe Haskell	None
Language	Haskell2010

Cardano.Network.Ping

Contents

API
Options and arguments
Log messages
- Formatting log messages
Exceptions
Cardano main-net configuration
Re-exports
Orphan instances

Synopsis

pingClients :: PingOpts -> [Address ('Unresolved 'SRVOrFilePathUnresolved)] -> IO ()
pingClients' :: Tracer IO (WithHost LogMsg) -> Tracer IO (WithHost LogInfoMsg) -> Tracer IO Header -> Tracer IO PingWarning -> PingOpts -> AcceptFilePath -> [Address ('Unresolved 'SRVOrFilePathUnresolved)] -> IO [PingException]
pingClient :: Tracer IO (WithHost LogMsg) -> Tracer IO (WithHost LogInfoMsg) -> Tracer IO Header -> Tracer IO PingWarning -> PingOpts -> AddrInfo -> IO (Either PingClientException ())
data PingOpts = PingOpts {
- pingOptsCount :: Word32
- pingOptsMagic :: NetworkMagic
- pingOptsJson :: LogFormat
- pingOptsQuiet :: Bool
- pingOptsMode :: PingMode
- pingOptsSRVPrefix :: String
- pingOptsColor :: ColorMode
}
data Stage
- = Unresolved ResolvedSRVOrFilePath
- | Resolved
data ResolvedSRVOrFilePath
- = SRVOrFilePathUnresolved
- | SRVOrFilePathResolved
data Address (stage :: Stage) where
- IP :: forall (stage :: Stage). IP -> Port -> Address stage
mkAddress :: String -> Address ('Unresolved 'SRVOrFilePathUnresolved)
cmdlineParser :: Parser (PingOpts, [Address ('Unresolved 'SRVOrFilePathUnresolved)])
data PingMode
- = TipMode
- | PingMode
- | QueryMode
data AcceptFilePath
- = AddressMightBeAFilePath
- | AddressIsNotAFilePath
data LogFormat
- = AsJSON
- | AsText
data ColorMode
- = ColorAuto
- | ColorNever
- | ColorAlways
data PingWarning
- = AddressResolutionError AddressResolutionError
- | DNSResolution Domain [IP] Word
- | Error SomeException
- | ConnectError SockAddr SomeException
data PingException
- = AddressResolutionException AddressResolutionError
- | PingClientException PingClientException
data WithHost a = WithHost SockAddr a
data LogMsg
- = LogChainSyncTip PingTip
- | LogStatPoint StatPoint
- | LogNodeToClientVersionData NodeToClientVersion (Either Text NodeToClientVersionData)
- | LogNodeToNodeVersionData NodeToNodeVersion (Either Text NodeToNodeVersionData)
data StatPoint = StatPoint {
- spTimestamp :: UTCTime
- spCookie :: Word16
- spSample :: Double
- spMedian :: Double
- spP90 :: Double
- spMean :: Double
- spMin :: Double
- spMax :: Double
- spStd :: Double
}
mkStdOutTracer :: IO (Tracer IO Text)
mkStdErrTracer :: IO (Tracer IO Text)
mkHeaderTracer :: PingOpts -> Tracer IO Text -> IO (Tracer IO Header)
format :: (ToText a, ToJSON a) => LogFormat -> a -> Text
class ToText a where
- toText :: a -> Text
data PingClientException
- = ProtocolLimitException ProtocolLimitFailure SockAddr
- | Show versionNumber => HandshakeException (HandshakeProtocolError versionNumber) SockAddr
- | IOException IOError SockAddr
- | DecodingException DeserialiseFailure SockAddr
- | MuxException Error SockAddr
mainnetMagic :: NetworkMagic
newtype NetworkMagic = NetworkMagic {
- unNetworkMagic :: Word32
}

API

pingClients :: PingOpts -> [Address ('Unresolved 'SRVOrFilePathUnresolved)] -> IO () Source #

pingClients' Source #

Arguments

:: Tracer IO (WithHost LogMsg)	trace log messages
-> Tracer IO (WithHost LogInfoMsg)	info messages (e.g. RTTs, negotiated version numbers)
-> Tracer IO Header	print header for ping measurements or tip information; it should be enabled if the first tracer is enabled.
-> Tracer IO PingWarning	trace warning messages
-> PingOpts	options for the ping command
-> AcceptFilePath	accept file paths as addresses; if set to `AddressIsNotAFilePath` we'll never return file path related errors in `AddressResolutionError`.
-> [Address ('Unresolved 'SRVOrFilePathUnresolved)]
-> IO [PingException]	returns two list: * list of resolve errors (printed with `PingWarning` tracer) * list of `pingClient` errors

A low level API which returns all address resolution & clients errors.

pingClient Source #

Arguments

:: Tracer IO (WithHost LogMsg)	stdout
-> Tracer IO (WithHost LogInfoMsg)	info tracer
-> Tracer IO Header
-> Tracer IO PingWarning	stderr
-> PingOpts
-> AddrInfo
-> IO (Either PingClientException ())

Run a single ping client.

Options and arguments

data PingOpts Source #

Constructors

PingOpts
Fields pingOptsCount :: Word32 Number of messages to send to the server pingOptsMagic :: NetworkMagic The network magic to use for all connections pingOptsJson :: LogFormat Print output in JSON pingOptsQuiet :: Bool Less verbose output pingOptsMode :: PingMode Ping mode pingOptsSRVPrefix :: String SRV prefix pingOptsColor :: ColorMode Colorised output

data Stage Source #

There are three stages for resolving addresses.

SRV might be a file path or a DNS name or an SRV record
SRV was resolved as an SRV record, if not
try to resolve it as a DNS name
if failed, try to use it as a file path

See resolveAddress

Constructors

Unresolved ResolvedSRVOrFilePath
Resolved

data ResolvedSRVOrFilePath Source #

Constructors

SRVOrFilePathUnresolved
SRVOrFilePathResolved

data Address (stage :: Stage) where Source #

Constructors

IP :: forall (stage :: Stage). IP -> Port -> Address stage

Instances

Instances details

Show (Address resolved) Source #
Instance details Defined in Cardano.Network.Ping Methods showsPrec :: Int -> Address resolved -> ShowS # show :: Address resolved -> String # showList :: [Address resolved] -> ShowS #
Eq (Address 'Resolved) Source #
Instance details Defined in Cardano.Network.Ping Methods (==) :: Address 'Resolved -> Address 'Resolved -> Bool # (/=) :: Address 'Resolved -> Address 'Resolved -> Bool #
Ord (Address 'Resolved) Source #
Instance details Defined in Cardano.Network.Ping Methods compare :: Address 'Resolved -> Address 'Resolved -> Ordering # (<) :: Address 'Resolved -> Address 'Resolved -> Bool # (<=) :: Address 'Resolved -> Address 'Resolved -> Bool # (>) :: Address 'Resolved -> Address 'Resolved -> Bool # (>=) :: Address 'Resolved -> Address 'Resolved -> Bool # max :: Address 'Resolved -> Address 'Resolved -> Address 'Resolved # min :: Address 'Resolved -> Address 'Resolved -> Address 'Resolved #

mkAddress :: String -> Address ('Unresolved 'SRVOrFilePathUnresolved) Source #

A smart constructor for Address type.

cmdlineParser :: Parser (PingOpts, [Address ('Unresolved 'SRVOrFilePathUnresolved)]) Source #

data PingMode Source #

Constructors

TipMode	query tip
PingMode	ping
QueryMode	query handshake parameters

Instances

Instances details

Show PingMode Source #
Instance details Defined in Cardano.Network.Ping Methods showsPrec :: Int -> PingMode -> ShowS # show :: PingMode -> String # showList :: [PingMode] -> ShowS #
Eq PingMode Source #
Instance details Defined in Cardano.Network.Ping Methods (==) :: PingMode -> PingMode -> Bool # (/=) :: PingMode -> PingMode -> Bool #

data AcceptFilePath Source #

resolveAddress has two modes of operations. It can try to resolve an Address to a FilePath, or not. In the latter case the errors will be more precise. It is useful when validating an srv record domain names ip addresses.

Constructors

AddressMightBeAFilePath
AddressIsNotAFilePath

data LogFormat Source #

Constructors

AsJSON
AsText

Instances

Instances details

Show LogFormat Source #
Instance details Defined in Cardano.Network.Ping Methods showsPrec :: Int -> LogFormat -> ShowS # show :: LogFormat -> String # showList :: [LogFormat] -> ShowS #
Eq LogFormat Source #
Instance details Defined in Cardano.Network.Ping Methods (==) :: LogFormat -> LogFormat -> Bool # (/=) :: LogFormat -> LogFormat -> Bool #

data ColorMode Source #

Constructors

ColorAuto
ColorNever
ColorAlways

Instances

Instances details

Show ColorMode Source #
Instance details Defined in Cardano.Network.Ping Methods showsPrec :: Int -> ColorMode -> ShowS # show :: ColorMode -> String # showList :: [ColorMode] -> ShowS #
Eq ColorMode Source #
Instance details Defined in Cardano.Network.Ping Methods (==) :: ColorMode -> ColorMode -> Bool # (/=) :: ColorMode -> ColorMode -> Bool #

Log messages

data PingWarning Source #

Log messages to stderr.

Constructors

AddressResolutionError AddressResolutionError
DNSResolution Domain [IP] Word
Error SomeException
ConnectError SockAddr SomeException

Instances

Instances details

ToText PingWarning Source #
Instance details Defined in Cardano.Network.Ping Methods toText :: PingWarning -> Text Source #

data PingException Source #

Constructors

AddressResolutionException AddressResolutionError
PingClientException PingClientException

Instances

Instances details

Exception PingException Source #
Instance details Defined in Cardano.Network.Ping Methods toException :: PingException -> SomeException # fromException :: SomeException -> Maybe PingException # displayException :: PingException -> String # backtraceDesired :: PingException -> Bool #
Show PingException Source #
Instance details Defined in Cardano.Network.Ping Methods showsPrec :: Int -> PingException -> ShowS # show :: PingException -> String # showList :: [PingException] -> ShowS #

data WithHost a Source #

Constructors

WithHost SockAddr a

Instances

Instances details

ToJSON a => ToJSON (WithHost a) Source #
Instance details Defined in Cardano.Network.Ping Methods toJSON :: WithHost a -> Value # toEncoding :: WithHost a -> Encoding # toJSONList :: [WithHost a] -> Value # toEncodingList :: [WithHost a] -> Encoding # omitField :: WithHost a -> Bool #
ToText a => ToText (WithHost a) Source #
Instance details Defined in Cardano.Network.Ping Methods toText :: WithHost a -> Text Source #
Show a => Show (WithHost a) Source #
Instance details Defined in Cardano.Network.Ping Methods showsPrec :: Int -> WithHost a -> ShowS # show :: WithHost a -> String # showList :: [WithHost a] -> ShowS #

data LogMsg Source #

Log messages to stdout.

Constructors

LogChainSyncTip PingTip
LogStatPoint StatPoint
LogNodeToClientVersionData NodeToClientVersion (Either Text NodeToClientVersionData)
LogNodeToNodeVersionData NodeToNodeVersion (Either Text NodeToNodeVersionData)

Instances

Instances details

ToJSON LogMsg Source #
Instance details Defined in Cardano.Network.Ping Methods toJSON :: LogMsg -> Value # toEncoding :: LogMsg -> Encoding # toJSONList :: [LogMsg] -> Value # toEncodingList :: [LogMsg] -> Encoding # omitField :: LogMsg -> Bool #
ToText LogMsg Source #
Instance details Defined in Cardano.Network.Ping Methods toText :: LogMsg -> Text Source #
Show LogMsg Source #
Instance details Defined in Cardano.Network.Ping Methods showsPrec :: Int -> LogMsg -> ShowS # show :: LogMsg -> String # showList :: [LogMsg] -> ShowS #

data StatPoint Source #

Constructors

StatPoint
Fields spTimestamp :: UTCTime time-stamp of the sample value spCookie :: Word16 sample number spSample :: Double current sample value spMedian :: Double median value spP90 :: Double 90 percentile spMean :: Double mean value spMin :: Double minimal value spMax :: Double maximal value spStd :: Double standard deviation

Instances

Instances details

ToJSON StatPoint Source #
Instance details Defined in Cardano.Network.Ping Methods toJSON :: StatPoint -> Value # toEncoding :: StatPoint -> Encoding # toJSONList :: [StatPoint] -> Value # toEncodingList :: [StatPoint] -> Encoding # omitField :: StatPoint -> Bool #
Show StatPoint Source #
Instance details Defined in Cardano.Network.Ping Methods showsPrec :: Int -> StatPoint -> ShowS # show :: StatPoint -> String # showList :: [StatPoint] -> ShowS #

mkStdOutTracer :: IO (Tracer IO Text) Source #

mkStdErrTracer :: IO (Tracer IO Text) Source #

mkHeaderTracer :: PingOpts -> Tracer IO Text -> IO (Tracer IO Header) Source #

Formatting log messages

format :: (ToText a, ToJSON a) => LogFormat -> a -> Text Source #

class ToText a where Source #

Methods

toText :: a -> Text Source #

Instances

Instances details

ToText NodeToClientVersion Source #
Instance details Defined in Cardano.Network.Ping Methods toText :: NodeToClientVersion -> Text Source #
ToText NodeToNodeVersion Source #
Instance details Defined in Cardano.Network.Ping Methods toText :: NodeToNodeVersion -> Text Source #
ToText LogMsg Source #
Instance details Defined in Cardano.Network.Ping Methods toText :: LogMsg -> Text Source #
ToText PingWarning Source #
Instance details Defined in Cardano.Network.Ping Methods toText :: PingWarning -> Text Source #
ToText Text Source #
Instance details Defined in Cardano.Network.Ping Methods toText :: Text -> Text Source #
ToText String Source #
Instance details Defined in Cardano.Network.Ping Methods toText :: String -> Text Source #
ToText a => ToText (WithHost a) Source #
Instance details Defined in Cardano.Network.Ping Methods toText :: WithHost a -> Text Source #

Exceptions

data PingClientException Source #

Constructors

ProtocolLimitException ProtocolLimitFailure SockAddr	protocol limit error
Show versionNumber => HandshakeException (HandshakeProtocolError versionNumber) SockAddr	handshake protocol error
IOException IOError SockAddr	IO errors
DecodingException DeserialiseFailure SockAddr	cbor exceptions
MuxException Error SockAddr	mux exceptions

Instances

Instances details

Exception PingClientException Source #
Instance details Defined in Cardano.Network.Ping Methods toException :: PingClientException -> SomeException # fromException :: SomeException -> Maybe PingClientException # displayException :: PingClientException -> String # backtraceDesired :: PingClientException -> Bool #
Show PingClientException Source #
Instance details Defined in Cardano.Network.Ping Methods showsPrec :: Int -> PingClientException -> ShowS # show :: PingClientException -> String # showList :: [PingClientException] -> ShowS #

Cardano main-net configuration

mainnetMagic :: NetworkMagic Source #

Re-exports

newtype NetworkMagic #

Constructors

NetworkMagic
Fields unNetworkMagic :: Word32

Instances

Instances details

NFData NetworkMagic

Instance details

Defined in Ouroboros.Network.Magic

Methods

rnf :: NetworkMagic -> () #

Generic NetworkMagic

Instance details

Defined in Ouroboros.Network.Magic

Associated Types

type Rep NetworkMagic
Instance details Defined in Ouroboros.Network.Magic type Rep NetworkMagic = D1 ('MetaData "NetworkMagic" "Ouroboros.Network.Magic" "ouroboros-network-1.1.0.0-inplace-api" 'True) (C1 ('MetaCons "NetworkMagic" 'PrefixI 'True) (S1 ('MetaSel ('Just "unNetworkMagic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))