vaultaire-common-2.9.1: lib/Vaultaire/Types.hs

--
-- |
-- Maintainer: The Vaultaire Team
-- Stability: Experimental
--
-- /Overview/
--
-- When communicating with a Vaultaire installation, you need to serialize
-- requests and deserialize responses. The bytes used over the wire are all
-- formed by making the various types involved instances of class 'WireFormat'.
--
-- As it happens, these types are also the same ones used in the internals of
-- Vaultaire as it persists measurements and metadata to disk.
--

module Vaultaire.Types
(
    -- * Identification of measurements
    Address(..),
    calculateBucketNumber,
    isAddressExtended,

    -- * Time of a measurement
    TimeStamp(..),
    convertToDiffTime,
    convertToTimeStamp,
    getCurrentTimeNanoseconds,

    -- * Namespacing and authentication
    Origin(..),
    makeOrigin,

    -- * Metadata about sources
    SourceDict,
    unionSource,
    diffSource,
    lookupSource,
    makeSourceDict,

    -- * Caching SourceDicts
    hashSource,
    SourceDictCache,
    emptySourceCache,
    insertSourceCache,
    memberSourceCache,
    sizeOfSourceCache,

    -- * Operations with the contents store
    ContentsOperation(..),
    ContentsResponse(..),
    ContentsListBypass(..),

    -- * Streaming reads
    ReadRequest(..),
    ReadStream(..),
    SimpleBurst(..),
    ExtendedBurst(..),

    -- * Decoded reads
    SimplePoint(..),
    ExtendedPoint(..),

    -- * Writes
    WriteResult(..),

    -- * Hacks
    PassThrough(..),

    -- * Conversion to and from wire format
    WireFormat(fromWire, toWire),

    -- * Internal
    DayMap(..),
    TeleResp(..),
    TeleMsg(..),
    TeleMsgType(..),
    TeleMsgUOM(..),
    msgTypeUOM,
    AgentID, agentIDLength, agentID,

    -- * Convenience/clarity
    Epoch,
    NumBuckets
) where

import Vaultaire.Classes.WireFormat
import Vaultaire.Types.Address
import Vaultaire.Types.Common
import Vaultaire.Types.ContentsListBypass
import Vaultaire.Types.ContentsOperation
import Vaultaire.Types.ContentsResponse
import Vaultaire.Types.DayMap
import Vaultaire.Types.Decoded
import Vaultaire.Types.PassThrough
import Vaultaire.Types.ReadRequest
import Vaultaire.Types.ReadStream
import Vaultaire.Types.SourceDict
import Vaultaire.Types.SourceDictCache
import Vaultaire.Types.Telemetry
import Vaultaire.Types.TimeStamp
import Vaultaire.Types.WriteResult