influxdb-1.2.2.3: Haskell client library for InfluxDB

Safe HaskellNone
LanguageHaskell2010

Database.InfluxDB.Ping

Contents

Synopsis

Ping interface

ping :: PingParams -> IO Pong Source #

Send a ping to InfluxDB.

It may throw an InfluxException.

Ping parameters

data PingParams Source #

The full set of parameters for the ping API

Instances

HasManager PingParams Source #
>>> let p = pingParams & manager .~ Left HC.defaultManagerSettings
HasServer PingParams Source #
>>> pingParams ^. server.host
"localhost"

pingParams :: PingParams Source #

Smart constructor for PingParams

Default parameters:

server
defaultServer
manager
Left defaultManagerSettings
timeout
Nothing

server :: HasServer a => Lens' a Server Source #

InfluxDB server address and port that to interact with.

manager :: HasManager a => Lens' a (Either ManagerSettings Manager) Source #

HTTP manager settings or a manager itself.

If it's set to ManagerSettings, the library will create a Manager from the settings for you.

timeout :: Lens' PingParams (Maybe NominalDiffTime) Source #

The number of seconds to wait before returning a response

>>> pingParams ^. timeout
Nothing
>>> let p = pingParams & timeout ?~ 1

Pong

data Pong Source #

Response of a ping request

Instances

Eq Pong Source # 

Methods

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

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

Ord Pong Source # 

Methods

compare :: Pong -> Pong -> Ordering #

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

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

(>) :: Pong -> Pong -> Bool #

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

max :: Pong -> Pong -> Pong #

min :: Pong -> Pong -> Pong #

Show Pong Source # 

Methods

showsPrec :: Int -> Pong -> ShowS #

show :: Pong -> String #

showList :: [Pong] -> ShowS #

roundtripTime :: Lens' Pong TimeSpec Source #

Round-trip time of the ping

influxdbVersion :: Lens' Pong ByteString Source #

Version string returned by InfluxDB