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

Class BlockingResource<W extends WaitKey>

java.lang.Object

com.hazelcast.cp.internal.datastructures.spi.blocking.BlockingResource<W>

Type Parameters:

W - concrete type of the WaitKey

All Implemented Interfaces:

DataSerializable

Direct Known Subclasses:

RaftCountDownLatch, RaftLock, RaftSemaphore

public abstract class BlockingResource<W extends WaitKey>
extends Object
implements DataSerializable

Operations on a BlockingResource may not return a response at commit-time. Such operations register WaitKey instances. Then, their wait keys can be completed in future when some other operations are committed or a timeout occurs.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlockingResource()
protected	BlockingResource(CPGroupId groupId, String name)

Method Summary

Modifier and Type	Method and Description
protected void	addWaitKey(Object waitKeyId, W waitKey)
protected void	clearWaitKeys()
protected void	cloneForSnapshot(BlockingResource<W> clone)
protected abstract Collection<Long>	getActivelyAttachedSessions() Returns a non-null collection of session ids that the current state of the resource is attached to.
protected Collection<W>	getAllWaitKeys()
CPGroupId	getGroupId()
Map<Object,WaitKeyContainer<W>>	getInternalWaitKeysMap()
String	getName()
protected WaitKeyContainer<W>	getWaitKeyContainer(Object waitKeyId)
protected String	internalToString()
protected abstract void	onSessionClose(long sessionId, Map<Long,Object> responses) Called when a session is closed.
protected void	onWaitKeyExpire(W waitKey)
void	readData(ObjectDataInput in) Reads fields from the input stream
protected void	removeWaitKey(Object waitKeyId)
protected Iterator<WaitKeyContainer<W>>	waitKeyContainersIterator()
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

Constructor Detail

BlockingResource

protected BlockingResource()

BlockingResource

protected BlockingResource(CPGroupId groupId,
                           String name)

Method Detail

getGroupId

public final CPGroupId getGroupId()

getName

public final String getName()

getInternalWaitKeysMap

public final Map<Object,WaitKeyContainer<W>> getInternalWaitKeysMap()

onSessionClose

protected abstract void onSessionClose(long sessionId,
                                       Map<Long,Object> responses)

Called when a session is closed. If current state of the resource is attached to the closed session, it must be cleaned up. The second parameter can be filled with new responses which are assigned to some wait keys during the cleanup process.

getActivelyAttachedSessions

protected abstract Collection<Long> getActivelyAttachedSessions()

Returns a non-null collection of session ids that the current state of the resource is attached to. For instance, owner sessions of semaphore permits.

addWaitKey

protected final void addWaitKey(Object waitKeyId,
                                W waitKey)

getWaitKeyContainer

protected final WaitKeyContainer<W> getWaitKeyContainer(Object waitKeyId)

removeWaitKey

protected final void removeWaitKey(Object waitKeyId)

getAllWaitKeys

protected final Collection<W> getAllWaitKeys()

onWaitKeyExpire

protected void onWaitKeyExpire(W waitKey)

waitKeyContainersIterator

protected final Iterator<WaitKeyContainer<W>> waitKeyContainersIterator()

clearWaitKeys

protected final void clearWaitKeys()

cloneForSnapshot

protected final void cloneForSnapshot(BlockingResource<W> clone)

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.

internalToString

protected final String internalToString()