Интерфейс TransferQueue<E>

public interface TransferQueue<E>
extends BlockingQueue<E>

A BlockingQueue в котором производители могут ожидать, пока потребители получат элементы. Очередь может быть полезна, например, в приложениях передачи сообщений, в которых производители иногда (используя метод transfer(E)) ожидают получения элементов потребителями, вызывающими take или poll, в то время как в другие моменты добавляют элементы (через метод put ), не ожидая получения. Неблокирующие и с таймаутом версии tryTransfer также доступны. Очередь можно запросить, используя hasWaitingConsumer(), есть ли потоки, ожидающие элементы, что является обратным аналогом операции peek.

Как и другие блокирующие очереди, TransferQueue может иметь ограниченную емкость. В этом случае попытка операции передачи может первоначально заблокировать ожидание доступного места и/или впоследствии заблокировать ожидание приема потребителем. Обратите внимание, что в очереди с нулевой емкостью, такой как SynchronousQueue, put и transfer фактически синонимичны.

Этот интерфейс является частью Java Collections Framework.

Методы

tryTransfer

boolean tryTransfer(E e)

Параметры:

e - элемент для передачи

Возвращает:

true если элемент был передан, иначе false

Исключения:

ClassCastException - если класс указанного элемента запрещает его добавление в эту очередь

NullPointerException - если указанный элемент равен null

IllegalArgumentException - если некоторые свойства указанного элемента препятствуют его добавлению в эту очередь

transfer

void transfer(E e)
       throws InterruptedException

Параметры:

e - элемент для передачи

Исключения:

InterruptedException - если прервано ожидание, в этом случае элемент не оставляется в очереди

ClassCastException - если класс указанного элемента запрещает его добавление в эту очередь

NullPointerException - если указанный элемент равен null

IllegalArgumentException - если некоторые свойства указанного элемента препятствуют его добавлению в эту очередь

tryTransfer

boolean tryTransfer(E e,
                    long timeout,
                    TimeUnit unit)
             throws InterruptedException

Параметры:

e - элемент для передачи

timeout - время ожидания, прежде чем отказаться, в единицах unit

unit - TimeUnit определяющий, как интерпретировать параметр timeout

Возвращает:

true если успешно, или false если указанное время ожидания истекает до завершения, в этом случае элемент не оставляется в очереди

Исключения:

InterruptedException - если прервано ожидание, в этом случае элемент не оставляется в очереди

ClassCastException - если класс указанного элемента запрещает его добавление в эту очередь

NullPointerException - если указанный элемент равен null

IllegalArgumentException - если некоторые свойства указанного элемента препятствуют его добавлению в эту очередь

hasWaitingConsumer

boolean hasWaitingConsumer()

Возвращает true если есть хотя бы один потребитель, ожидающий получения элемента через BlockingQueue.take() или с таймаутом poll. Значение возврата представляет мгновенное состояние.

Возвращает:

true если есть хотя бы один ожидающий потребитель

getWaitingConsumerCount

int getWaitingConsumerCount()

Возвращает оценку количества потребителей, ожидающих получения элементов через BlockingQueue.take() или с таймаутом poll. Возвращаемое значение является приближением мгновенного состояния, которое может быть неточным, если потребители завершили или отказались от ожидания. Значение может быть полезным для мониторинга и эвристики, но не для управления синхронизацией. Реализации этого метода, вероятно, будут заметно медленнее, чем реализации для hasWaitingConsumer().

Возвращает:

количество ожидающих элементов