com.amazonaws.services.kinesis.clientlibrary.lib.worker

Class KinesisConsumerStates

java.lang.Object

com.amazonaws.services.kinesis.clientlibrary.lib.worker.KinesisConsumerStates

public class KinesisConsumerStates
extends Object

Top level container for all the possible states a KinesisShardConsumer can be in. The logic for creation of tasks, and state transitions is contained within the KinesisConsumerStates.ConsumerState objects.

State Diagram

       +-------------------+
       | Waiting on Parent |                               +------------------+
  +----+       Shard       |                               |     Shutdown     |
  |    |                   |          +--------------------+   Notification   |
  |    +----------+--------+          |  Shutdown:         |     Requested    |
  |               | Success           |   Requested        +-+-------+--------+
  |               |                   |                      |       |
  |        +------+-------------+     |                      |       | Shutdown:
  |        |    Initializing    +-----+                      |       |  Requested
  |        |                    |     |                      |       |
  |        |                    +-----+-------+              |       |
  |        +---------+----------+     |       | Shutdown:    | +-----+-------------+
  |                  | Success        |       |  Terminated  | |     Shutdown      |
  |                  |                |       |  Zombie      | |   Notification    +-------------+
  |           +------+-------------+  |       |              | |     Complete      |             |
  |           |     Processing     +--+       |              | ++-----------+------+             |
  |       +---+                    |          |              |  |           |                    |
  |       |   |                    +----------+              |  |           | Shutdown:          |
  |       |   +------+-------------+          |              \  /           |  Requested         |
  |       |          |                        |               \/            +--------------------+
  |       |          |                        |               ||
  |       | Success  |                        |               || Shutdown:
  |       +----------+                        |               ||  Terminated
  |                                           |               ||  Zombie
  |                                           |               ||
  |                                           |               ||
  |                                           |           +---++--------------+
  |                                           |           |   Shutting Down   |
  |                                           +-----------+                   |
  |                                                       |                   |
  |                                                       +--------+----------+
  |                                                                |
  |                                                                | Shutdown:
  |                                                                |  All Reasons
  |                                                                |
  |                                                                |
  |      Shutdown:                                        +--------+----------+
  |        All Reasons                                    |     Shutdown      |
  +-------------------------------------------------------+     Complete      |
                                                          |                   |
                                                          +-------------------+
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KinesisConsumerStates.ConsumerState Represents a the current state of the consumer.
static class	KinesisConsumerStates.InitializingState This state is responsible for initializing the record processor with the shard information.
static class	KinesisConsumerStates.ShardConsumerState Enumerates processing states when working on a shard.

Constructor Summary

Constructors

Constructor and Description
KinesisConsumerStates()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KinesisConsumerStates

public KinesisConsumerStates()