Safe Haskell	Safe
Language	Haskell2010

Control.Concurrent.STM.Batch

Contents

Batch Operations
Time Utilities
Re-exports

Synopsis

data Batch a
newBatch :: Int -> Maybe TimeSpec -> ([a] -> STM ()) -> IO (Batch a)
writeBatch :: Batch a -> a -> IO ()
flushBatch :: Batch a -> STM ()
fromMilliSecs :: Integer -> TimeSpec
fromSecs :: Integer -> TimeSpec
fromMicroSecs :: Integer -> TimeSpec
data TimeSpec = TimeSpec {
- sec :: !Int64
- nsec :: !Int64
}

Documentation

data Batch a Source #

Opaque batch with buffer and settings.

Batch Operations

newBatch Source #

Arguments

:: Int	Max items in a batch
-> Maybe TimeSpec	Batch timeout
-> ([a] -> STM ())	Handler for complete batch
-> IO (Batch a)	Batch with settings

Constructs a new batcher state. If a batch timeout is configured this operation will automatically spawn a timeout handler thread. The timeout handler will automatically be killed when the batcher is garbage collected.

writeBatch :: Batch a -> a -> IO () Source #

Add a single item to the batch. The batch is automatically flushed when full.

flushBatch :: Batch a -> STM () Source #

Fires the batchHandler for the current batch from the current thread. This function is automatically called for a timeout or when buffer is filled by a write operation.

Time Utilities

fromMilliSecs :: Integer -> TimeSpec Source #

Convenience function for timeout in milliseconds.

fromSecs :: Integer -> TimeSpec Source #

Convenience function for timeout in seconds.

fromMicroSecs :: Integer -> TimeSpec Source #

Highest resolution time supported by internal usage of threadDelay.

Re-exports

data TimeSpec #

TimeSpec structure

Constructors

TimeSpec
Fields sec :: !Int64 seconds nsec :: !Int64 nanoseconds

Instances

Eq TimeSpec
Instance details Defined in System.Clock Methods (==) :: TimeSpec -> TimeSpec -> Bool # (/=) :: TimeSpec -> TimeSpec -> Bool #
Num TimeSpec
Instance details Defined in System.Clock Methods (+) :: TimeSpec -> TimeSpec -> TimeSpec # (-) :: TimeSpec -> TimeSpec -> TimeSpec # (*) :: TimeSpec -> TimeSpec -> TimeSpec # negate :: TimeSpec -> TimeSpec # abs :: TimeSpec -> TimeSpec # signum :: TimeSpec -> TimeSpec # fromInteger :: Integer -> TimeSpec #
Ord TimeSpec
Instance details Defined in System.Clock Methods compare :: TimeSpec -> TimeSpec -> Ordering # (<) :: TimeSpec -> TimeSpec -> Bool # (<=) :: TimeSpec -> TimeSpec -> Bool # (>) :: TimeSpec -> TimeSpec -> Bool # (>=) :: TimeSpec -> TimeSpec -> Bool # max :: TimeSpec -> TimeSpec -> TimeSpec # min :: TimeSpec -> TimeSpec -> TimeSpec #
Read TimeSpec
Instance details Defined in System.Clock Methods readsPrec :: Int -> ReadS TimeSpec # readList :: ReadS [TimeSpec] # readPrec :: ReadPrec TimeSpec # readListPrec :: ReadPrec [TimeSpec] #
Show TimeSpec
Instance details Defined in System.Clock Methods showsPrec :: Int -> TimeSpec -> ShowS # show :: TimeSpec -> String # showList :: [TimeSpec] -> ShowS #
Generic TimeSpec
Instance details Defined in System.Clock Associated Types type Rep TimeSpec :: * -> * # Methods from :: TimeSpec -> Rep TimeSpec x # to :: Rep TimeSpec x -> TimeSpec #
Storable TimeSpec
Instance details Defined in System.Clock Methods sizeOf :: TimeSpec -> Int # alignment :: TimeSpec -> Int # peekElemOff :: Ptr TimeSpec -> Int -> IO TimeSpec # pokeElemOff :: Ptr TimeSpec -> Int -> TimeSpec -> IO () # peekByteOff :: Ptr b -> Int -> IO TimeSpec # pokeByteOff :: Ptr b -> Int -> TimeSpec -> IO () # peek :: Ptr TimeSpec -> IO TimeSpec # poke :: Ptr TimeSpec -> TimeSpec -> IO () #
type Rep TimeSpec
Instance details Defined in System.Clock type Rep TimeSpec = D1 (MetaData "TimeSpec" "System.Clock" "clock-0.7.2-ErKmPTjVISxJnEb9XKUAOs" False) (C1 (MetaCons "TimeSpec" PrefixI True) (S1 (MetaSel (Just "sec") SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64) :*: S1 (MetaSel (Just "nsec") SourceUnpack SourceStrict DecidedStrict) (Rec0 Int64)))