co.cask.cdap.data2.queue

Interface QueueConsumer

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractQueueConsumer, ForwardingQueueConsumer, InMemoryQueueConsumer, LevelDBQueueConsumer

public interface QueueConsumer
extends Closeable

Interface for queue consumer.

Method Summary

Methods

Modifier and Type	Method and Description
DequeueResult<byte[]>	dequeue() Dequeue an entry from the queue.
DequeueResult<byte[]>	dequeue(int maxBatchSize) Dequeue multiple entries from the queue.
ConsumerConfig	getConfig() Returns the configuration of this consumer.
QueueName	getQueueName() Returns the queue name that this consumer is working on.

Methods inherited from interface java.io.Closeable

close

Method Detail

getQueueName

QueueName getQueueName()

Returns the queue name that this consumer is working on.

getConfig

ConsumerConfig getConfig()

Returns the configuration of this consumer.

dequeue

DequeueResult<byte[]> dequeue()
                              throws IOException

Dequeue an entry from the queue.

Returns:

A DequeueResult.

Throws:

IOException

dequeue

DequeueResult<byte[]> dequeue(int maxBatchSize)
                              throws IOException

Dequeue multiple entries from the queue. The dequeue result may have less entries than the given maxBatchSize, depending on how many entries in the queue.

Parameters:

maxBatchSize - Maximum number of entries to queue.

Returns:

A DequeueResult.

Throws:

IOException