Interface QueueBase<T>

All Superinterfaces:
AutoCloseable, Closeable
All Known Implementing Classes:
DistributedDelayQueue, DistributedIdQueue, DistributedPriorityQueue, DistributedQueue
public interface QueueBase<T> extends Closeable

  • Method Details

    • start

      void start() throws Exception
      Start the queue. No other methods work until this is called
      Throws:
      Exception - startup errors

    • getPutListenerContainer

      org.apache.curator.framework.listen.Listenable<QueuePutListener<T>> getPutListenerContainer()
      Return the manager for put listeners
      Returns:
      put listener container

    • setErrorMode

      void setErrorMode(ErrorMode newErrorMode)
      Used when the queue is created with a QueueBuilder.lockPath(String). Determines the behavior when the queue consumer throws an exception
      Parameters:
      newErrorMode - the new error mode (the default is ErrorMode.REQUEUE

    • flushPuts

      boolean flushPuts(long waitTime, TimeUnit timeUnit) throws InterruptedException
      Wait until any pending puts are committed
      Parameters:
      waitTime - max wait time
      timeUnit - time unit
      Returns:
      true if the flush was successful, false if it timed out first
      Throws:
      InterruptedException - if thread was interrupted

    • getLastMessageCount

      int getLastMessageCount()
      Return the most recent message count from the queue. This is useful for debugging/information purposes only.
      Returns:
      count (can be 0)