org.zeromq

Class ZMQ.CancellationToken

java.lang.Object

org.zeromq.ZMQ.CancellationToken

Enclosing class:

ZMQ

public static class ZMQ.CancellationToken
extends Object

A cancellation token that allows canceling ongoing Socket send/receive operations. When calling send/receive you can provide the cancellation token as an additional parameter. To create a cancellation token call ZMQ.Socket.createCancellationToken().

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicBoolean	canceled

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CancellationToken(SocketBase socket)

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel a pending the send/receive operation.
boolean	isCancellationRequested()
void	reset() Reset the cancellation token in order to reuse the token with another send/receive call.

Methods inherited from class java.lang.Object

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

Field Detail

canceled

protected AtomicBoolean canceled

Constructor Detail

CancellationToken

protected CancellationToken(SocketBase socket)

Method Detail

isCancellationRequested

public boolean isCancellationRequested()

reset

public void reset()

Reset the cancellation token in order to reuse the token with another send/receive call.

cancel

public void cancel()

Cancel a pending the send/receive operation.