Moduleekg-core-0.1.2.0Haskell2010

System.Metrics.Gauge

This module defines a type for mutable, integer-valued gauges. Gauges are variable values and can be used to track e.g. the current number of concurrent connections. All operations on gauges are thread-safe.

Synopsis

newtype Gauge
value new
value read
value inc
value dec
value add
value subtract
value set

Packageekg-core-0.1.2.0
Exports8
LanguageHaskell2010
LicenceBSD-3-Clause
SourceGauge.hs

newtypenewtype Gauge

Source#

A mutable, integer-valued gauge.

valuenew :: IO Gauge

Source#

Create a new, zero initialized, gauge.

valueread :: Gauge -> IO Int64

Source#

Get the current value of the gauge.

valueinc :: Gauge -> IO ()

Source#

Increase the gauge by one.

valuedec :: Gauge -> IO ()

Source#

Decrease the gauge by one.

valueadd :: Gauge -> Int64 -> IO ()

Source#

Increase the gauge by the given amount.

valuesubtract :: Gauge -> Int64 -> IO ()

Source#

Decrease the gauge by the given amount.

valueset :: Gauge -> Int64 -> IO ()

Source#

Set the gauge to the given value.