WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Java

Flow.Subscription — Nachfrage und Kündigung

Flow.Subscription steuert die Übermittlung von Elementen zwischen Publisher und Subscriber. request(long n) erhöht die Nachfrage, während cancel() den Empfang beendet, ohne zu garantieren, dass die Übermittlung sofort stoppt.

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

Syntax

import java.util.concurrent.Flow;

Flow.Subscription subscription;
// Interface methods:
void request(long n);
void cancel();

Flow.Subscription verbindet einen Flow.Publisher mit einem Flow.Subscriber. Der Subscriber erhält sie in onSubscribe vor den übrigen Callbacks. Dieser Flusssteuerungsmechanismus (Backpressure) ermöglicht dem Empfänger festzulegen, wie viele Elemente er bereit ist anzunehmen; ohne Anforderung erhält er keine Elemente über onNext.

Flow.Subscription.request(long n) addiert n zur noch offenen Nachfrage, statt sie zu ersetzen. Falls der Stream endet, können weniger Elemente eintreffen. Long.MAX_VALUE kann eine praktisch unbegrenzte Nachfrage bedeuten. Ist das Abonnement aktiv, wird dem Subscriber bei n <= 0 eine IllegalArgumentException über onError gemeldet, statt dass request die Ausnahme synchron wirft. Nach der Kündigung des Abonnements bleibt request auch bei n <= 0 ohne Wirkung.

Flow.Subscription.cancel() beendet den Empfang nach dem Best-Effort-Prinzip: Weitere Nachrichten können trotzdem eintreffen. Weder onComplete noch onError werden garantiert. Beide Methoden sind ausschließlich für den zugehörigen Subscriber vorgesehen; eine andere Verwendung hat undefinierte Auswirkungen.

Das Beispiel verwendet SubmissionPublisher mit dem Executor Runnable::run, um Aufgaben im aktuellen Thread auszuführen, ohne dass es zu einem Wettlauf mit dem Programmende kommt. Der Subscriber fordert zwei Elemente an und kündigt nach dem zweiten. Die erwartete Ausgabe lautet 10 und 20, jeweils in einer eigenen Zeile, ohne complete. Dies ist ein Beispiel für Java SE 21 und keine Bestätigung für eine Produktionsumgebung.

Beispiele

import java.util.concurrent.Flow;
import java.util.concurrent.SubmissionPublisher;

public class Main {
    public static void main(String[] args) {
        try (var publisher = new SubmissionPublisher<Integer>(Runnable::run, 4)) {
            publisher.subscribe(new Flow.Subscriber<Integer>() {
                private Flow.Subscription subscription;
                private int received;

                @Override
                public void onSubscribe(Flow.Subscription s) {
                    subscription = s;
                    subscription.request(2);
                }

                @Override
                public void onNext(Integer item) {
                    System.out.println(item);
                    if (++received == 2) {
                        subscription.cancel();
                    }
                }

                @Override
                public void onError(Throwable error) {
                    System.out.println(error.getClass().getSimpleName());
                }

                @Override
                public void onComplete() {
                    System.out.println("complete");
                }
            });
            publisher.submit(10);
            publisher.submit(20);
            publisher.submit(30);
        }
    }
}

Ergebnis

10
20

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen