CancellationTokenSource

Creates a new CancellationToken or cancels one that has already created. There is a 1:1 CancellationTokenSource to CancellationToken relationship.

To create a CancellationToken, create a CancellationTokenSource first and then call getToken() to get the CancellationToken for this CancellationTokenSource.

Public Constructor Summary

CancellationTokenSource()

Creates a new CancellationTokenSource instance.

Public Method Summary

void	cancel() Cancels the `CancellationToken` if cancellation has not been requested yet.
CancellationToken	getToken() Gets the `CancellationToken` for this `CancellationTokenSource`.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Constructors

public CancellationTokenSource ()

Creates a new CancellationTokenSource instance.

Public Methods

public void cancel ()

Cancels the CancellationToken if cancellation has not been requested yet.

public CancellationToken getToken ()

Gets the CancellationToken for this CancellationTokenSource.

Returns

the CancellationToken that can be passed to asynchronous Task to cancel the Task.

See Also