com.yahoo.bullet.pubsub

Interface Subscriber

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BufferingSubscriber, RESTSubscriber

public interface Subscriber
extends AutoCloseable

Method Summary

Modifier and Type	Method and Description
void	commit(String id) Commits allow clients to implement at least once, at most once or exactly once semantics when processing messages.
void	fail(String id) Marks the processing of the PubSubMessage with the given id as failed.
PubSubMessage	receive() Gets a new PubSubMessage from the assigned partition/partitions (Here a partition is a unit of parallelism in the Pub/Sub queue, See PubSub).

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

receive

PubSubMessage receive()
               throws PubSubException

Gets a new PubSubMessage from the assigned partition/partitions (Here a partition is a unit of parallelism in the Pub/Sub queue, See PubSub).

Returns:

the received PubSubMessage.

Throws:

PubSubException - when a receive fails.

commit

void commit(String id)

Commits allow clients to implement at least once, at most once or exactly once semantics when processing messages. Common implementations might 1. Ack all received messages. 2. Commit current read offset to persistent/fault tolerant storage.

Parameters:

id - The ID of the message to be marked as committed.

fail

void fail(String id)

Marks the processing of the PubSubMessage with the given id as failed.

Parameters:

id - The ID of the PubSubMessage to mark as a processing failure.