Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / Java

BlockingQueue — kolejka z operacjami oczekującymi

BlockingQueue<E> umożliwia bezpieczną wymianę elementów między wątkami, np. producentem i konsumentem. Rozróżnia operacje bez oczekiwania na miejsce lub element, operacje oczekujące oraz warianty z limitem czasu. Przykład używa ArrayBlockingQueue o pojemności 1.

Wersja: Java SE 21; repository runtime, production runtime not attested

Składnia

BlockingQueue<E> queue = new ArrayBlockingQueue<>(capacity);
boolean accepted = queue.offer(element);
E removed = queue.poll();
queue.put(element); // throws InterruptedException
E received = queue.take(); // throws InterruptedException
E head = queue.peek();
int count = queue.size();
boolean acceptedInTime = queue.offer(element, timeout, unit);
E receivedInTime = queue.poll(timeout, unit);

BlockingQueue<E> z pakietu java.util.concurrent rozszerza Queue<E>. Implementacje są bezpieczne wątkowo i służą m.in. do komunikacji producent–konsument. Pojemność i porządek zależą od implementacji: ArrayBlockingQueue ma stałą pojemność i porządek FIFO; sam interfejs nie gwarantuje FIFO.

BlockingQueue.offer(e) zwraca true po dodaniu albo false, gdy nie ma miejsca. BlockingQueue.poll() usuwa i zwraca element z początku albo zwraca null, gdy kolejka jest pusta. BlockingQueue.peek() odczytuje początek bez usuwania, a dla pustej kolejki zwraca null. Te warianty nie czekają na miejsce ani element. BlockingQueue.size() zwraca liczbę elementów, ale wynik może się zmienić przed następną operacją; nie używaj go do sprawdzania, czy późniejsze dodanie lub pobranie się powiedzie.

BlockingQueue.put(e) czeka na miejsce, a BlockingQueue.take() czeka na element i go usuwa. Mogą czekać bezterminowo. Warianty offer(e, timeout, unit) i poll(timeout, unit) ograniczają oczekiwanie, zwracając odpowiednio false lub null po wyczerpaniu czasu bez powodzenia. Operacje oczekujące deklarują InterruptedException; przekaż wyjątek dalej albo obsłuż przerwanie bez jego ignorowania.

Elementy null są zabronione. Pojedyncze operacje kolejkowe są atomowe, ale sekwencja kilku wywołań nie staje się przez to atomowa. Interfejs nie ma wbudowanej operacji zamknięcia; zakończenie pracy wymaga osobnego protokołu.

Przykład jednowątkowy pokazuje deterministycznie pełną i pustą kolejkę. put i take mogą zakończyć się od razu, ponieważ mają odpowiednio wolne miejsce i dostępny element; przykład nie demonstruje oczekiwania między wątkami.

Przykłady

import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.BlockingQueue;

public class Main {
    public static void main(String[] args) throws InterruptedException {
        BlockingQueue<String> queue = new ArrayBlockingQueue<>(1);

        System.out.println(queue.offer("A"));
        System.out.println(queue.offer("B"));
        System.out.println(queue.peek());
        System.out.println(queue.size());
        System.out.println(queue.poll());
        System.out.println(queue.poll());

        queue.put("C");
        System.out.println(queue.take());
        System.out.println(queue.size());
    }
}

Wynik

true
false
A
1
A
null
C
0

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła