com.couchbase.client.dcp.highlevel.internal

Class DatabaseChangeConsumerOps

java.lang.Object

com.couchbase.client.dcp.highlevel.internal.DatabaseChangeConsumerOps

All Implemented Interfaces:

BlockingQueueConsumerOps<DatabaseChangeEvent>

public class DatabaseChangeConsumerOps
extends Object
implements BlockingQueueConsumerOps<DatabaseChangeEvent>

Optionally auto-acknowledges events as they are consumed.

Constructor Summary

Constructors

Constructor and Description
DatabaseChangeConsumerOps(BlockingQueue<DatabaseChangeEvent> queue, FlowControlMode flowControlMode)

Method Summary

Modifier and Type	Method and Description
DatabaseChangeEvent	poll(long timeout, TimeUnit unit) Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.
DatabaseChangeEvent	take() Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatabaseChangeConsumerOps

public DatabaseChangeConsumerOps(BlockingQueue<DatabaseChangeEvent> queue,
                                 FlowControlMode flowControlMode)

Method Detail

take

public DatabaseChangeEvent take()
                         throws InterruptedException

Description copied from interface: BlockingQueueConsumerOps

Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.

Specified by:

take in interface BlockingQueueConsumerOps<DatabaseChangeEvent>

Returns:

the head of this queue

Throws:

InterruptedException - if interrupted while waiting

poll

public DatabaseChangeEvent poll(long timeout,
                                TimeUnit unit)
                         throws InterruptedException

Description copied from interface: BlockingQueueConsumerOps

Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.

Specified by:

poll in interface BlockingQueueConsumerOps<DatabaseChangeEvent>

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the head of this queue, or null if the specified waiting time elapses before an element is available

Throws:

InterruptedException - if interrupted while waiting