java.util.concurrent

Interface TransferQueue<E>

Table des matières
  • Type Parameters:
    E - the type of elements held in this collection
    All Superinterfaces:
    BlockingQueue<E>, Collection<E>, Iterable<E>, Queue<E>
    All Known Implementing Classes:
    LinkedTransferQueue

    public interface TransferQueue<E>
extends BlockingQueue<E>
    A BlockingQueue in which producers may wait for consumers to receive elements. A TransferQueue may be useful for example in message passing applications in which producers sometimes (using method transfer(E)) await receipt of elements by consumers invoking take or poll, while at other times enqueue elements (via method put) without waiting for receipt. Non-blocking and time-out versions of tryTransfer are also available. A TransferQueue may also be queried, via hasWaitingConsumer(), whether there are any threads waiting for items, which is a converse analogy to a peek operation.

    Like other blocking queues, a TransferQueue may be capacity bounded. If so, an attempted transfer operation may initially block waiting for available space, and/or subsequently block waiting for reception by a consumer. Note that in a queue with zero capacity, such as SynchronousQueue, put and transfer are effectively synonymous.

    This interface is a member of the Java Collections Framework.

    Since:
    1.7

    • Method Detail

      • tryTransfer

        boolean tryTransfer(E e)
        Transfers the element to a waiting consumer immediately, if possible.

        More precisely, transfers the specified element immediately if there exists a consumer already waiting to receive it (in BlockingQueue.take() or timed poll), otherwise returning false without enqueuing the element.

        Parameters:
        e - the element to transfer
        Returns:
        true if the element was transferred, else false
        Throws:
        ClassCastException - if the class of the specified element prevents it from being added to this queue
        NullPointerException - if the specified element is null
        IllegalArgumentException - if some property of the specified element prevents it from being added to this queue

      • transfer

        void transfer(E e)
              throws InterruptedException
        Transfers the element to a consumer, waiting if necessary to do so.

        More precisely, transfers the specified element immediately if there exists a consumer already waiting to receive it (in BlockingQueue.take() or timed poll), else waits until the element is received by a consumer.

        Parameters:
        e - the element to transfer
        Throws:
        InterruptedException - if interrupted while waiting, in which case the element is not left enqueued
        ClassCastException - if the class of the specified element prevents it from being added to this queue
        NullPointerException - if the specified element is null
        IllegalArgumentException - if some property of the specified element prevents it from being added to this queue

      • tryTransfer

        boolean tryTransfer(E e,
                  long timeout,
                  TimeUnit unit)
                    throws InterruptedException
        Transfers the element to a consumer if it is possible to do so before the timeout elapses.

        More precisely, transfers the specified element immediately if there exists a consumer already waiting to receive it (in BlockingQueue.take() or timed poll), else waits until the element is received by a consumer, returning false if the specified wait time elapses before the element can be transferred.

        Parameters:
        e - the element to transfer
        timeout - how long to wait before giving up, in units of unit
        unit - a TimeUnit determining how to interpret the timeout parameter
        Returns:
        true if successful, or false if the specified waiting time elapses before completion, in which case the element is not left enqueued
        Throws:
        InterruptedException - if interrupted while waiting, in which case the element is not left enqueued
        ClassCastException - if the class of the specified element prevents it from being added to this queue
        NullPointerException - if the specified element is null
        IllegalArgumentException - if some property of the specified element prevents it from being added to this queue

      • hasWaitingConsumer

        boolean hasWaitingConsumer()
        Returns true if there is at least one consumer waiting to receive an element via BlockingQueue.take() or timed poll. The return value represents a momentary state of affairs.
        Returns:
        true if there is at least one waiting consumer

      • getWaitingConsumerCount

        int getWaitingConsumerCount()
        Returns an estimate of the number of consumers waiting to receive elements via BlockingQueue.take() or timed poll. The return value is an approximation of a momentary state of affairs, that may be inaccurate if consumers have completed or given up waiting. The value may be useful for monitoring and heuristics, but not for synchronization control. Implementations of this method are likely to be noticeably slower than those for hasWaitingConsumer().
        Returns:
        the number of consumers waiting to receive elements

Traduction non disponible

Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.

Version en cache

18/11/2024 02:20:45 Cette version de la page est en cache (à la date du 18/11/2024 02:20:45) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.

Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/util/concurrent/transferqueue.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :fr Manuel PHP : https://docs.oracle.com

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.

Table des matières Haut