Freigeben über

CancellationToken Klasse

  • Referenz
Paket:
system.fabric
  • java.lang.Object
    • AutoCloseable
      • system.fabric.CancellationToken

public class CancellationToken

Ein CancellationToken wird verwendet, um die Benachrichtigung zu verteilen, dass Vorgänge abgebrochen werden sollen. Sie erstellen ein Abbruchtoken, indem Sie ein CancellationTokenSource -Objekt instanziieren, das Abbruchtoken verwaltet, die von seiner getToken() -Methode abgerufen werden. Anschließend übergeben Sie das Abbruchtoken an eine beliebige Anzahl von Vorgängen, die eine Kündigungsbenachrichtigung erhalten sollen. Das Token kann nicht zum Initiieren des Abbruchs verwendet werden. Wenn das besitzende Objekt aufruft cancel(), wird die abgebrochene Eigenschaft für das Abbruchtoken auf true festgelegt. Die Objekte, die die Benachrichtigung empfangen, können auf jede geeignete Weise reagieren.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
boolean canBeCancelled()

Gibt an, ob das Abbruchtoken abgebrochen werden kann oder nicht. Wenn mit system.fabric.CancellationTokengetToken()erstellt wird, kann das Token mit cancel() der -Methode abgebrochen werden. Wenn mit system.fabric.CancellationToken erstellt getDefault()wird, kann es nicht abgebrochen werden. Es fungiert einfach als Dummytoken.

void close()
CancellationToken getDefault()

Erstellt und gibt ein Abbruchtokenobjekt zurück. Diese Methode sollte verwendet werden, wenn CancellationToken den Abbruch nicht unterstützt. Nur Abbruchtoken, die über getToken() erstellt werden, unterstützen Abbrüche.
boolean isCancelled()

Ruft einen Wert ab, der angibt, ob für dieses Token ein Abbruch angefordert wurde.
void registerCancellationCallback(Runnable callback)

Registriert einen Rückruf, der ausgeführt wird, wenn dieses system.fabric.CancellationToken Objekt abgebrochen wird.

void registerCancellationCallback(String name, Runnable callback)

Registriert einen Rückruf, der ausgeführt wird, wenn dieses system.fabric.CancellationToken Objekt abgebrochen wird.

void throwIfCancellationRequested()

Löst eine CancellationException aus, wenn für dieses Token ein Abbruch angefordert wurde.

void unregisterCancellationCallback()

Heben Sie die Registrierung des Rückrufs für dieses system.fabric.CancellationToken Objekt auf.

void unregisterCancellationCallback(String name)

Heben Sie die Registrierung des Rückrufs für dieses system.fabric.CancellationToken Objekt auf.

Details zur Methode

canBeCancelled

public boolean canBeCancelled()

Gibt an, ob das Abbruchtoken abgebrochen werden kann oder nicht. Wenn mit system.fabric.CancellationTokengetToken()erstellt wird, kann das Token mit cancel() der -Methode abgebrochen werden. Wenn mit system.fabric.CancellationToken erstellt getDefault()wird, kann es nicht abgebrochen werden. Es fungiert einfach als Dummytoken.

Gibt zurück:

Gibt true zurück, wenn das Token abgebrochen werden kann, andernfalls false.

close

public void close()

getDefault

public static CancellationToken getDefault()

Erstellt und gibt ein Abbruchtokenobjekt zurück. Diese Methode sollte verwendet werden, wenn CancellationToken den Abbruch nicht unterstützt. Nur Abbruchtoken, die über getToken() erstellt werden, unterstützen Abbrüche.

Gibt zurück:

isCancelled

public boolean isCancelled()

Ruft einen Wert ab, der angibt, ob für dieses Token ein Abbruch angefordert wurde.

Gibt zurück:

Boolescher status

registerCancellationCallback

public void registerCancellationCallback(Runnable callback)

Registriert einen Rückruf, der ausgeführt wird, wenn dieses system.fabric.CancellationToken Objekt abgebrochen wird.

Parameter:

callback -

java.lang.Runnable ausgeführt werden soll, wenn das Token abgebrochen wird.

registerCancellationCallback

public void registerCancellationCallback(String name, Runnable callback)

Registriert einen Rückruf, der ausgeführt wird, wenn dieses system.fabric.CancellationToken Objekt abgebrochen wird.

Parameter:

name - Rückrufname.
callback -

java.lang.Runnable ausgeführt werden soll, wenn das Token abgebrochen wird.

throwIfCancellationRequested

public void throwIfCancellationRequested()

Löst eine CancellationException aus, wenn für dieses Token ein Abbruch angefordert wurde.

unregisterCancellationCallback

public void unregisterCancellationCallback()

Heben Sie die Registrierung des Rückrufs für dieses system.fabric.CancellationToken Objekt auf.

unregisterCancellationCallback

public void unregisterCancellationCallback(String name)

Heben Sie die Registrierung des Rückrufs für dieses system.fabric.CancellationToken Objekt auf.

Parameter:

name - Für dieses system.fabric.CancellationToken Objekt registrierter Rückrufname.

Gilt für: