Safe Haskell	Safe-Inferred
Language	Haskell2010

Testnet.Ping

Synopsis

pingNode :: MonadIO m => TestnetMagic -> Sprocket -> m (Either PingClientError ())
checkSprocket :: MonadIO m => Sprocket -> m (Either IOException ())
waitForSprocket :: MonadIO m => DiffTime -> DiffTime -> Sprocket -> m (Either IOException ())
type TestnetMagic = Word32
data PingClientError
- = PceDecodingError !String !DeserialiseFailure
- | PceProtocolError !String !HandshakeFailure
- | PceVersionNegotiationError !String ![NodeVersion] ![NodeVersion]

Documentation

pingNode Source #

Arguments

:: MonadIO m
=> TestnetMagic	testnet magic
-> Sprocket	node sprocket
-> m (Either PingClientError ())	`()` means success

Ping the node once

checkSprocket :: MonadIO m => Sprocket -> m (Either IOException ()) Source #

Check if the sprocket can be connected to. Returns an exception thrown during the connection attempt.

waitForSprocket Source #

Arguments

:: MonadIO m
=> DiffTime	timeout
-> DiffTime	interval
-> Sprocket
-> m (Either IOException ())

Wait for sprocket to become ready. Periodically tries to connect to sprocket, with the provided interval. If there was no success within timeout period, return the last exception thrown during a connection attempt.

type TestnetMagic = Word32 Source #

data PingClientError Source #

Constructors

PceDecodingError
Fields !String peer string !DeserialiseFailure deserialization exception
PceProtocolError
Fields !String peer string !HandshakeFailure handshake exception
PceVersionNegotiationError
Fields !String peer string ![NodeVersion] requested versions ![NodeVersion] received node versions

Instances

Instances details

Error PingClientError Source #
Instance details Defined in Testnet.Ping Methods prettyError :: PingClientError -> Doc ann #