com.hazelcast.cp.internal.datastructures.spi.blocking

Class WaitKey

java.lang.Object

com.hazelcast.cp.internal.datastructures.spi.blocking.WaitKey

All Implemented Interfaces:

DataSerializable

Direct Known Subclasses:

AcquireInvocationKey, AwaitInvocationKey, LockInvocationKey

public abstract class WaitKey
extends Object
implements DataSerializable

This abstraction is used when an operation does not return a response at commit-time. Such an operation will either return a response in future or timeout. Future completions of such operations are represented with implementations of this interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected Address	callerAddress
protected long	callId
protected long	commitIndex
protected UUID	invocationUid

Constructor Summary

Constructors

Constructor and Description
WaitKey()
WaitKey(long commitIndex, UUID invocationUid, Address callerAddress, long callId)

Method Summary

Modifier and Type	Method and Description
Address	callerAddress() Returns address of the caller which created this wait key
long	callId() Returns the call id which created this wait key
long	commitIndex() Returns commit index of the operation that has not returned a response at the time of its commit.
UUID	invocationUid() Returns unique id of the committed operation which is provided by the caller.
void	readData(ObjectDataInput in) Reads fields from the input stream
abstract long	sessionId() Returns id of the session to which the corresponding operation is attached.
void	writeData(ObjectDataOutput out) Writes object fields to output stream

Methods inherited from class java.lang.Object

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

Field Detail

commitIndex

protected long commitIndex

invocationUid

protected UUID invocationUid

callerAddress

protected Address callerAddress

callId

protected long callId

Constructor Detail

WaitKey

public WaitKey()

WaitKey

public WaitKey(long commitIndex,
               UUID invocationUid,
               Address callerAddress,
               long callId)

Method Detail

sessionId

public abstract long sessionId()

Returns id of the session to which the corresponding operation is attached. Returns AbstractProxySessionManager.NO_SESSION_ID if no session is attached.

commitIndex

public final long commitIndex()

Returns commit index of the operation that has not returned a response at the time of its commit.

invocationUid

public final UUID invocationUid()

Returns unique id of the committed operation which is provided by the caller.

callerAddress

public final Address callerAddress()

Returns address of the caller which created this wait key

callId

public final long callId()

Returns the call id which created this wait key

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Parameters:

out - output

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Parameters:

in - input

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.