118 lines
6.4 KiB
Go
118 lines
6.4 KiB
Go
/*
|
|
* Copyright (c) 2018 VMware, Inc.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
|
* associated documentation files (the "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is furnished to do
|
|
* so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all copies or substantial
|
|
* portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
|
|
* NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
// Package interfaces
|
|
// The implementation is derived from https://github.com/awslabs/amazon-kinesis-client
|
|
/*
|
|
* Copyright 2014-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
*
|
|
* Licensed under the Amazon Software License (the "License").
|
|
* You may not use this file except in compliance with the License.
|
|
* A copy of the License is located at
|
|
*
|
|
* http://aws.amazon.com/asl/
|
|
*
|
|
* or in the "license" file accompanying this file. This file is distributed
|
|
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
|
|
* express or implied. See the License for the specific language governing
|
|
* permissions and limitations under the License.
|
|
*/
|
|
|
|
package interfaces
|
|
|
|
type (
|
|
IPreparedCheckpointer interface {
|
|
GetPendingCheckpoint() *ExtendedSequenceNumber
|
|
|
|
// Checkpoint
|
|
/*
|
|
* This method will record a pending checkpoint.
|
|
*
|
|
* @error ThrottlingError Can't store checkpoint. Can be caused by checkpointing too frequently.
|
|
* Consider increasing the throughput/capacity of the checkpoint store or reducing checkpoint frequency.
|
|
* @error ShutdownError The record processor instance has been shutdown. Another instance may have
|
|
* started processing some of these records already.
|
|
* The application should abort processing via this RecordProcessor instance.
|
|
* @error InvalidStateError Can't store checkpoint.
|
|
* Unable to store the checkpoint in the DynamoDB table (e.g. table doesn't exist).
|
|
* @error KinesisClientLibDependencyError Encountered an issue when storing the checkpoint. The application can
|
|
* backoff and retry.
|
|
* @error IllegalArgumentError The sequence number being checkpointed is invalid because it is out of range,
|
|
* i.e. it is smaller than the last check point value (prepared or committed), or larger than the greatest
|
|
* sequence number seen by the associated record processor.
|
|
*/
|
|
Checkpoint() error
|
|
}
|
|
|
|
// IRecordProcessorCheckpointer
|
|
/*
|
|
* Used by RecordProcessors when they want to checkpoint their progress.
|
|
* The Kinesis Client Library will pass an object implementing this interface to RecordProcessors, so they can
|
|
* checkpoint their progress.
|
|
*/
|
|
IRecordProcessorCheckpointer interface {
|
|
// Checkpoint
|
|
/*
|
|
* This method will checkpoint the progress at the provided sequenceNumber. This method is analogous to
|
|
* {@link #checkpoint()} but provides the ability to specify the sequence number at which to
|
|
* checkpoint.
|
|
*
|
|
* @param sequenceNumber A sequence number at which to checkpoint in this shard. Upon failover,
|
|
* the Kinesis Client Library will start fetching records after this sequence number.
|
|
* @error ThrottlingError Can't store checkpoint. Can be caused by checkpointing too frequently.
|
|
* Consider increasing the throughput/capacity of the checkpoint store or reducing checkpoint frequency.
|
|
* @error ShutdownError The record processor instance has been shutdown. Another instance may have
|
|
* started processing some of these records already.
|
|
* The application should abort processing via this RecordProcessor instance.
|
|
* @error InvalidStateError Can't store checkpoint.
|
|
* Unable to store the checkpoint in the DynamoDB table (e.g. table doesn't exist).
|
|
* @error KinesisClientLibDependencyError Encountered an issue when storing the checkpoint. The application can
|
|
* backoff and retry.
|
|
* @error IllegalArgumentError The sequence number is invalid for one of the following reasons:
|
|
* 1.) It appears to be out of range, i.e. it is smaller than the last check point value, or larger than the
|
|
* greatest sequence number seen by the associated record processor.
|
|
* 2.) It is not a valid sequence number for a record in this shard.
|
|
*/
|
|
Checkpoint(sequenceNumber *string) error
|
|
|
|
// PrepareCheckpoint
|
|
/**
|
|
* This method will record a pending checkpoint at the provided sequenceNumber.
|
|
*
|
|
* @param sequenceNumber A sequence number at which to prepare checkpoint in this shard.
|
|
|
|
* @return an IPreparedCheckpointer object that can be called later to persist the checkpoint.
|
|
*
|
|
* @error ThrottlingError Can't store pending checkpoint. Can be caused by checkpointing too frequently.
|
|
* Consider increasing the throughput/capacity of the checkpoint store or reducing checkpoint frequency.
|
|
* @error ShutdownError The record processor instance has been shutdown. Another instance may have
|
|
* started processing some of these records already.
|
|
* The application should abort processing via this RecordProcessor instance.
|
|
* @error InvalidStateError Can't store pending checkpoint.
|
|
* Unable to store the checkpoint in the DynamoDB table (e.g. table doesn't exist).
|
|
* @error KinesisClientLibDependencyError Encountered an issue when storing the pending checkpoint. The
|
|
* application can backoff and retry.
|
|
* @error IllegalArgumentError The sequence number is invalid for one of the following reasons:
|
|
* 1.) It appears to be out of range, i.e. it is smaller than the last check point value, or larger than the
|
|
* greatest sequence number seen by the associated record processor.
|
|
* 2.) It is not a valid sequence number for a record in this shard.
|
|
*/
|
|
PrepareCheckpoint(sequenceNumber *string) (IPreparedCheckpointer, error)
|
|
}
|
|
)
|