co.cask.cdap.messaging.store

Interface PayloadTable

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractPayloadTable, LevelDBPayloadTable

public interface PayloadTable
extends Closeable

An interface defining the Payload Table operations.

See Also:

Design documentation

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PayloadTable.Entry Represents an entry (row) in the payload table.

Method Summary

Modifier and Type	Method and Description
co.cask.cdap.api.dataset.lib.CloseableIterator<PayloadTable.Entry>	fetch(TopicMetadata metadata, long transactionWritePointer, MessageId messageId, boolean inclusive, int limit) Fetches entries from the payload table under the given topic, starting from the given MessageId.
void	store(Iterator<? extends PayloadTable.Entry> entries) Stores a list of entries to the payload table under the given topic.

Methods inherited from interface java.io.Closeable

close

Method Detail

fetch

co.cask.cdap.api.dataset.lib.CloseableIterator<PayloadTable.Entry> fetch(TopicMetadata metadata,
                                                                         long transactionWritePointer,
                                                                         MessageId messageId,
                                                                         boolean inclusive,
                                                                         int limit)
                                                                  throws IOException

Fetches entries from the payload table under the given topic, starting from the given MessageId.

Parameters:

metadata - TopicMetadata of the topic to fetch from

transactionWritePointer - transaction write pointer

messageId - message Id to start from

inclusive - true to include the entry identified by the given MessageId as the first message

limit - maximum number of entries to fetch

Returns:

a CloseableIterator of entries

Throws:

IOException

store

void store(Iterator<? extends PayloadTable.Entry> entries)
    throws IOException

Stores a list of entries to the payload table under the given topic.

Parameters:

entries - a list of entries to store. This method guarantees each PayloadTable.Entry will be consumed right away, hence it is safe for the Iterator to reuse the same PayloadTable.Entry instance

Throws:

IOException