org.apache.hudi.common.util.queue

Interface HoodieMessageQueue<I,O>

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

BoundedInMemoryQueue, DisruptorMessageQueue

public interface HoodieMessageQueue<I,O>
extends Closeable

HoodieMessageQueue holds an internal message queue, and control the behavior of 1. insert record into internal message queue. 2. get record from internal message queue. 3. close internal message queue.

Method Summary

Modifier and Type	Method and Description
void	close() Shuts down the queue, cleaning up the resources
Throwable	getThrowable()
void	insertRecord(I t) Insert a record into inner message queue.
boolean	isEmpty()
void	markAsFailed(Throwable e) API to allow producers and consumer to communicate termination due to failure.
Option<O>	readNextRecord() Read records from inner message queue.
void	seal() Seals the queue (for writing) preventing new records to be enqueued
long	size() Returns the number of elements in this queue.

Method Detail

size

long size()

Returns the number of elements in this queue.

insertRecord

void insertRecord(I t)
           throws Exception

Insert a record into inner message queue.

Throws:

Exception

readNextRecord

Option<O> readNextRecord()

Read records from inner message queue.

markAsFailed

void markAsFailed(Throwable e)

API to allow producers and consumer to communicate termination due to failure.

getThrowable

Throwable getThrowable()

isEmpty

boolean isEmpty()

seal

void seal()

Seals the queue (for writing) preventing new records to be enqueued

close

void close()

Shuts down the queue, cleaning up the resources

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable