DistributedQueue

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class DistributedQueue.ProcessType

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`DistributedQueue.ProcessType`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`boolean`	`flushPuts(long waitTime, java.util.concurrent.TimeUnit timeUnit)` Wait until any pending puts are committed
`protected java.util.List<java.lang.String>`	`getChildren()`
`protected long`	`getDelay(java.lang.String itemNode)`
`int`	`getLastMessageCount()` Return the most recent message count from the queue.
`ListenerContainer<QueuePutListener<T>>`	`getPutListenerContainer()` Return the manager for put listeners
`protected boolean`	`processWithLockSafety(java.lang.String itemNode, DistributedQueue.ProcessType type)`
`void`	`put(T item)` Add an item into the queue.
`boolean`	`put(T item, int maxWait, java.util.concurrent.TimeUnit unit)` Same as `put(Object)` but allows a maximum wait time if an upper bound was set via `QueueBuilder.maxItems`.
`void`	`putMulti(MultiItem<T> items)` Add a set of items into the queue.
`boolean`	`putMulti(MultiItem<T> items, int maxWait, java.util.concurrent.TimeUnit unit)` Same as `putMulti(MultiItem)` but allows a maximum wait time if an upper bound was set via `QueueBuilder.maxItems`.
`void`	`setErrorMode(ErrorMode newErrorMode)` Used when the queue is created with a `QueueBuilder.lockPath(String)`.
`protected void`	`sortChildren(java.util.List<java.lang.String> children)`
`void`	`start()` Start the queue.
`protected boolean`	`tryRemove(java.lang.String itemNode)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - start
```
public void start()
           throws java.lang.Exception
```
    Start the queue. No other methods work until this is called
    
    Specified by:
    
    start in interface QueueBase<T>
    
    Throws:
    
    java.lang.Exception - startup errors
  - close
```
public void close()
           throws java.io.IOException
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException
  - getPutListenerContainer
```
public ListenerContainer<QueuePutListener<T>> getPutListenerContainer()
```
    Return the manager for put listeners
    
    Specified by:
    
    getPutListenerContainer in interface QueueBase<T>
    
    Returns:
    put listener container
  - setErrorMode
```
public 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
    
    Specified by:
    
    setErrorMode in interface QueueBase<T>
    
    Parameters:
    newErrorMode - the new error mode (the default is ErrorMode.REQUEUE
  - flushPuts
```
public boolean flushPuts(long waitTime,
                java.util.concurrent.TimeUnit timeUnit)
                  throws java.lang.InterruptedException
```
    Wait until any pending puts are committed
    
    Specified by:
    
    flushPuts in interface QueueBase<T>
    
    Parameters:
    waitTime - max wait time
    timeUnit - time unit
    
    Returns:
    true if the flush was successful, false if it timed out first
    
    Throws:
    
    java.lang.InterruptedException - if thread was interrupted
  - put
```
public void put(T item)
         throws java.lang.Exception
```
    Add an item into the queue. Adding is done in the background - thus, this method will return quickly.
    
    NOTE: if an upper bound was set via QueueBuilder.maxItems, this method will block until there is available space in the queue.
    
    Parameters:
    item - item to add
    
    Throws:
    
    java.lang.Exception - connection issues
  - put
```
public boolean put(T item,
          int maxWait,
          java.util.concurrent.TimeUnit unit)
            throws java.lang.Exception
```
    Same as put(Object) but allows a maximum wait time if an upper bound was set via QueueBuilder.maxItems.
    
    Parameters:
    item - item to add
    maxWait - maximum wait
    unit - wait unit
    
    Returns:
    true if items was added, false if timed out
    
    Throws:
    
    java.lang.Exception
  - putMulti
```
public void putMulti(MultiItem<T> items)
              throws java.lang.Exception
```
    Add a set of items into the queue. Adding is done in the background - thus, this method will return quickly.
    
    NOTE: if an upper bound was set via QueueBuilder.maxItems, this method will block until there is available space in the queue.
    
    Parameters:
    items - items to add
    
    Throws:
    
    java.lang.Exception - connection issues
  - putMulti
```
public boolean putMulti(MultiItem<T> items,
               int maxWait,
               java.util.concurrent.TimeUnit unit)
                 throws java.lang.Exception
```
    Same as putMulti(MultiItem) but allows a maximum wait time if an upper bound was set via QueueBuilder.maxItems.
    
    Parameters:
    items - items to add
    maxWait - maximum wait
    unit - wait unit
    
    Returns:
    true if items was added, false if timed out
    
    Throws:
    
    java.lang.Exception
  - getLastMessageCount
```
public int getLastMessageCount()
```
    Return the most recent message count from the queue. This is useful for debugging/information purposes only.
    
    Specified by:
    
    getLastMessageCount in interface QueueBase<T>
    
    Returns:
    count (can be 0)
  - sortChildren
```
protected void sortChildren(java.util.List<java.lang.String> children)
```
  - getChildren
```
protected java.util.List<java.lang.String> getChildren()
                                                throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getDelay
```
protected long getDelay(java.lang.String itemNode)
```
  - tryRemove
```
protected boolean tryRemove(java.lang.String itemNode)
                     throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - processWithLockSafety
```
protected boolean processWithLockSafety(java.lang.String itemNode,
                            DistributedQueue.ProcessType type)
                                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception

Class DistributedQueue<T>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

start

close

getPutListenerContainer

setErrorMode

flushPuts

put

put

putMulti

putMulti

getLastMessageCount

sortChildren

getChildren

getDelay

tryRemove

processWithLockSafety