Copyright | Copyright © 2013-2014 PivotCloud, Inc. |
---|---|
License | Apache-2.0 |
Maintainer | Jon Sterling <jsterling@alephcloud.com> |
Stability | experimental |
Safe Haskell | None |
Language | Haskell2010 |
- data KinesisConsumer
- managedKinesisConsumer :: MonadConsumer m => ConsumerKit -> Codensity m KinesisConsumer
- withKinesisConsumer :: MonadConsumer m => ConsumerKit -> (KinesisConsumer -> m α) -> m α
- consumerSource :: MonadConsumer m => KinesisConsumer -> Source m Record
- readConsumer :: MonadConsumer m => KinesisConsumer -> m Record
- tryReadConsumer :: MonadConsumer m => KinesisConsumer -> m (Maybe Record)
- data ConsumerKit = ConsumerKit {}
- ckKinesisKit :: Lens' ConsumerKit KinesisKit
- ckStreamName :: Lens' ConsumerKit StreamName
- ckBatchSize :: Lens' ConsumerKit Int
- data ConsumerError
- type MonadConsumer m = (MonadIO m, MonadBaseControl IO m, MonadError ConsumerError m)
The Consumer
data KinesisConsumer Source
The KinesisConsumer
maintains state about which shards to pull from.
managedKinesisConsumer :: MonadConsumer 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 :: MonadConsumer m => ConsumerKit -> (KinesisConsumer -> m α) -> m α Source
This constructs a KinesisConsumer
and closes it when you have done with
it.
Commands
consumerSource :: MonadConsumer m => KinesisConsumer -> Source m Record Source
A conduit for getting records.
readConsumer :: MonadConsumer m => KinesisConsumer -> m Record Source
Await and read a single record from the consumer.
tryReadConsumer :: MonadConsumer 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.
Consumer Environment
data ConsumerKit Source
The ConsumerKit
contains what is needed to initialize a KinesisConsumer
.
ConsumerKit | |
|
ckKinesisKit :: Lens' ConsumerKit KinesisKit Source
A lens for _ckKinesisKit
.
ckStreamName :: Lens' ConsumerKit StreamName Source
A lens for _ckStreamName
.
ckBatchSize :: Lens' ConsumerKit Int Source
A lens for _ckBatchSize
.
data ConsumerError Source
NoShards | A stream must always have at least one open shard. |
KinesisError !SomeException | An error which derives from a request made to Kinesis. |
type MonadConsumer m = (MonadIO m, MonadBaseControl IO m, MonadError ConsumerError m) Source
The basic effect modality required for operating the consumer.