Copyright | Copyright © 2013-2015 PivotCloud, Inc. |
---|---|
License | Apache-2.0 |
Maintainer | Jon Sterling <jsterling@alephcloud.com> |
Stability | experimental |
Safe Haskell | None |
Language | Haskell2010 |
- data KinesisConsumer
- managedKinesisConsumer :: (MonadIO m, MonadBaseControl IO m) => ConsumerKit -> Codensity m KinesisConsumer
- withKinesisConsumer :: (MonadIO m, MonadBaseControl IO m) => ConsumerKit -> (KinesisConsumer -> m α) -> m α
- consumerSource :: MonadIO m => KinesisConsumer -> Source m Record
- readConsumer :: MonadIO m => KinesisConsumer -> m Record
- tryReadConsumer :: MonadIO m => KinesisConsumer -> m (Maybe Record)
- consumerStreamState :: MonadIO m => KinesisConsumer -> m SavedStreamState
- data ConsumerKit = ConsumerKit {}
- makeConsumerKit :: KinesisKit -> StreamName -> ConsumerKit
- data SavedStreamState
- ckKinesisKit :: Lens' ConsumerKit KinesisKit
- ckStreamName :: Lens' ConsumerKit StreamName
- ckBatchSize :: Lens' ConsumerKit Natural
- ckIteratorType :: Lens' ConsumerKit ShardIteratorType
- ckSavedStreamState :: Lens' ConsumerKit (Maybe SavedStreamState)
The Consumer
data KinesisConsumer Source
The KinesisConsumer
maintains state about which shards to pull from.
managedKinesisConsumer :: (MonadIO m, MonadBaseControl IO m) => ConsumerKit -> Codensity m KinesisConsumer Source
This constructs a KinesisConsumer
and closes it when you have done with
it; this is equivalent to withKinesisConsumer
, except that the
continuation is replaced with returning the consumer in Codensity
.
withKinesisConsumer :: (MonadIO m, MonadBaseControl IO m) => ConsumerKit -> (KinesisConsumer -> m α) -> m α Source
This constructs a KinesisConsumer
and closes it when you have done with
it.
Commands
consumerSource :: MonadIO m => KinesisConsumer -> Source m Record Source
A conduit for getting records.
readConsumer :: MonadIO m => KinesisConsumer -> m Record Source
Await and read a single record from the consumer.
tryReadConsumer :: MonadIO m => KinesisConsumer -> m (Maybe Record) Source
Try to read a single record from the consumer; if there is non queued up,
then Nothing
will be returned.
consumerStreamState :: MonadIO m => KinesisConsumer -> m SavedStreamState Source
Get the last read sequence number at each shard.
Consumer Environment
data ConsumerKit Source
The ConsumerKit
contains what is needed to initialize a KinesisConsumer
.
ConsumerKit | |
|
makeConsumerKit :: KinesisKit -> StreamName -> ConsumerKit Source
Create a ConsumerKit
with default settings (using iterator type
Latest
and a batch size of 200
).
Lenses
ckKinesisKit :: Lens' ConsumerKit KinesisKit Source
A lens for _ckKinesisKit
.
ckStreamName :: Lens' ConsumerKit StreamName Source
A lens for _ckStreamName
.
ckBatchSize :: Lens' ConsumerKit Natural Source
A lens for _ckBatchSize
.
ckIteratorType :: Lens' ConsumerKit ShardIteratorType Source
A lens for _ckIteratorType
.
ckSavedStreamState :: Lens' ConsumerKit (Maybe SavedStreamState) Source
A lens for _ckSavedStreamState
.