bolts

Class CancellationTokenSource

java.lang.Object

bolts.CancellationTokenSource

public class CancellationTokenSource
extends java.lang.Object

Signals to a CancellationToken that it should be canceled. To create a CancellationToken first create a CancellationTokenSource then call getToken() to retrieve the token for the source.

See Also:

CancellationToken, getToken()

Constructor Summary

Constructors

Constructor and Description
CancellationTokenSource() Create a new CancellationTokenSource.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels the token if it has not already been cancelled.
CancellationToken	getToken()
boolean	isCancellationRequested()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CancellationTokenSource

public CancellationTokenSource()

Create a new CancellationTokenSource.

Method Detail

isCancellationRequested

public boolean isCancellationRequested()

Returns:

true if cancellation has been requested for this CancellationTokenSource.

getToken

public CancellationToken getToken()

Returns:

the token that can be passed to asynchronous method to control cancellation.

cancel

public void cancel()

Cancels the token if it has not already been cancelled.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object