Safe Haskell	None
Language	Haskell2010

Cardano.Network.Ping

Documentation

data PingOpts Source #

Constructors

PingOpts

Fields

pingOptsCount :: Word32
Number of messages to send to the server
pingOptsHost :: Maybe String
The host to connect to
pingOptsHandshakeQuery :: Bool
Whether to send a query during the handshake to request the available protocol versions
pingOptsUnixSock :: Maybe String
The unix socket to connect to
pingOptsPort :: String
The port to connect to
pingOptsMagic :: Word32
The network magic to use for the connection
pingOptsJson :: Bool
Print output in JSON
pingOptsQuiet :: Bool
Less verbose output
pingOptsGetTip :: Bool
Get Tip after handshake

Instances

Instances details

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

data LogMsg Source #

Constructors

LogMsg ByteString
LogEnd

Instances

Instances details

Show LogMsg Source #
Instance details Defined in Cardano.Network.Ping Methods showsPrec :: Int -> LogMsg -> ShowS # show :: LogMsg -> String # showList :: [LogMsg] -> ShowS #

data NodeVersion Source #

Constructors

NodeToClientVersionV9 Word32
NodeToClientVersionV10 Word32
NodeToClientVersionV11 Word32
NodeToClientVersionV12 Word32
NodeToClientVersionV13 Word32
NodeToClientVersionV14 Word32
NodeToClientVersionV15 Word32
NodeToClientVersionV16 Word32
NodeToClientVersionV17 Word32
NodeToClientVersionV18 Word32
NodeToClientVersionV19 Word32
NodeToNodeVersionV1 Word32
NodeToNodeVersionV2 Word32
NodeToNodeVersionV3 Word32
NodeToNodeVersionV4 Word32 InitiatorOnly
NodeToNodeVersionV5 Word32 InitiatorOnly
NodeToNodeVersionV6 Word32 InitiatorOnly
NodeToNodeVersionV7 Word32 InitiatorOnly
NodeToNodeVersionV8 Word32 InitiatorOnly
NodeToNodeVersionV9 Word32 InitiatorOnly
NodeToNodeVersionV10 Word32 InitiatorOnly
NodeToNodeVersionV11 Word32 InitiatorOnly
NodeToNodeVersionV12 Word32 InitiatorOnly
NodeToNodeVersionV13 Word32 InitiatorOnly PeerSharing
NodeToNodeVersionV14 Word32 InitiatorOnly PeerSharing

Instances

Instances details

ToJSON NodeVersion Source #
Instance details Defined in Cardano.Network.Ping Methods toJSON :: NodeVersion -> Value # toEncoding :: NodeVersion -> Encoding # toJSONList :: [NodeVersion] -> Value # toEncodingList :: [NodeVersion] -> Encoding # omitField :: NodeVersion -> Bool #
Show NodeVersion Source #
Instance details Defined in Cardano.Network.Ping Methods showsPrec :: Int -> NodeVersion -> ShowS # show :: NodeVersion -> String # showList :: [NodeVersion] -> ShowS #
Eq NodeVersion Source #
Instance details Defined in Cardano.Network.Ping Methods (==) :: NodeVersion -> NodeVersion -> Bool # (/=) :: NodeVersion -> NodeVersion -> Bool #
Ord NodeVersion Source #
Instance details Defined in Cardano.Network.Ping Methods compare :: NodeVersion -> NodeVersion -> Ordering # (<) :: NodeVersion -> NodeVersion -> Bool # (<=) :: NodeVersion -> NodeVersion -> Bool # (>) :: NodeVersion -> NodeVersion -> Bool # (>=) :: NodeVersion -> NodeVersion -> Bool # max :: NodeVersion -> NodeVersion -> NodeVersion # min :: NodeVersion -> NodeVersion -> NodeVersion #

data HandshakeFailure Source #

Constructors

UnknownVersionInRsp Word
UnknownKey Word
UnknownTag Word
VersionMissmath [Word]
DecodeError Word String
Refused Word String

Instances

Instances details

Show HandshakeFailure Source #
Instance details Defined in Cardano.Network.Ping Methods showsPrec :: Int -> HandshakeFailure -> ShowS # show :: HandshakeFailure -> String # showList :: [HandshakeFailure] -> ShowS #

data StatPoint Source #

Constructors

StatPoint
Fields spTimestamp :: UTCTime spHost :: String spCookie :: Word16 spSample :: Double spMedian :: Double spP90 :: Double spMean :: Double spMin :: Double spMax :: Double spStd :: Double

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 #

data InitiatorOnly Source #

Constructors

InitiatorOnly
InitiatorAndResponder

Instances

Instances details

ToJSON InitiatorOnly Source #

Instance details

Defined in Cardano.Network.Ping

Methods

toJSON :: InitiatorOnly -> Value #

toEncoding :: InitiatorOnly -> Encoding #

toJSONList :: [InitiatorOnly] -> Value #

toEncodingList :: [InitiatorOnly] -> Encoding #

omitField :: InitiatorOnly -> Bool #

Bounded InitiatorOnly Source #

Instance details

Defined in Cardano.Network.Ping

Methods

minBound :: InitiatorOnly #

maxBound :: InitiatorOnly #

Generic InitiatorOnly Source #

Instance details

Defined in Cardano.Network.Ping

Associated Types

type Rep InitiatorOnly
Instance details Defined in Cardano.Network.Ping type Rep InitiatorOnly = D1 ('MetaData "InitiatorOnly" "Cardano.Network.Ping" "cardano-ping-0.6.0.0-inplace" 'False) (C1 ('MetaCons "InitiatorOnly" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InitiatorAndResponder" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: InitiatorOnly -> Rep InitiatorOnly x #

to :: Rep InitiatorOnly x -> InitiatorOnly #

Show InitiatorOnly Source #

Instance details

Defined in Cardano.Network.Ping

Methods

showsPrec :: Int -> InitiatorOnly -> ShowS #

show :: InitiatorOnly -> String #

showList :: [InitiatorOnly] -> ShowS #

Eq InitiatorOnly Source #

Instance details

Defined in Cardano.Network.Ping

Methods

(==) :: InitiatorOnly -> InitiatorOnly -> Bool #

(/=) :: InitiatorOnly -> InitiatorOnly -> Bool #

Ord InitiatorOnly Source #

Instance details

Defined in Cardano.Network.Ping

Methods

compare :: InitiatorOnly -> InitiatorOnly -> Ordering #

(<) :: InitiatorOnly -> InitiatorOnly -> Bool #

(<=) :: InitiatorOnly -> InitiatorOnly -> Bool #

(>) :: InitiatorOnly -> InitiatorOnly -> Bool #

(>=) :: InitiatorOnly -> InitiatorOnly -> Bool #

max :: InitiatorOnly -> InitiatorOnly -> InitiatorOnly #

min :: InitiatorOnly -> InitiatorOnly -> InitiatorOnly #

type Rep InitiatorOnly Source #

Instance details

Defined in Cardano.Network.Ping

type Rep InitiatorOnly = D1 ('MetaData "InitiatorOnly" "Cardano.Network.Ping" "cardano-ping-0.6.0.0-inplace" 'False) (C1 ('MetaCons "InitiatorOnly" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InitiatorAndResponder" 'PrefixI 'False) (U1 :: Type -> Type))

mainnetMagic :: Word32 Source #

pingClient :: Tracer IO LogMsg -> Tracer IO String -> PingOpts -> [NodeVersion] -> AddrInfo -> IO () Source #

logger :: StrictTMVar IO LogMsg -> Bool -> Bool -> Bool -> IO () Source #

supportedNodeToNodeVersions :: Word32 -> [NodeVersion] Source #

supportedNodeToClientVersions :: Word32 -> [NodeVersion] Source #

handshakeDec :: Decoder s (Either HandshakeFailure [NodeVersion]) Source #

handshakeReq :: [NodeVersion] -> Bool -> ByteString Source #

isSameVersionAndMagic :: NodeVersion -> NodeVersion -> Bool Source #