net.lecousin.framework.concurrent.async

Class ReadWriteLockPoint

java.lang.Object

net.lecousin.framework.concurrent.async.ReadWriteLockPoint

public class ReadWriteLockPoint
extends Object

A ReadWriteLockPoint is like a lock point but allows several readers at the same time.

• Several threads can be in read mode at the same time
• Only one thread can be in write mode at the same time
• The read and write modes are exclusive

Constructor Summary

Constructors

Constructor and Description
ReadWriteLockPoint()

Method Summary

Modifier and Type	Method and Description
void	endRead() To call when the thread leaves the read mode and release this lock point.
void	endWrite() To call when the thread leaves the write mode and release this lock point.
boolean	isUsed() Return true if there is currently neither reader or writer.
void	startRead() To call when a thread wants to enter read mode.
Async<NoException>	startReadAsync() To call when a thread wants to enter read mode.
Async<NoException>	startReadAsync(boolean returnNullIfReady) To call when a thread wants to enter read mode.
void	startWrite() To call when a thread wants to enter write mode.
Async<NoException>	startWriteAsync() To call when a thread wants to enter write mode.
Async<NoException>	startWriteAsync(boolean returnNullIfReady) To call when a thread wants to enter write mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadWriteLockPoint

public ReadWriteLockPoint()

Method Detail

startRead

public void startRead()

To call when a thread wants to enter read mode. If the lock point is used in write mode, this method will block until it is released.

startReadAsync

public Async<NoException> startReadAsync()

To call when a thread wants to enter read mode. If read can start immediately, this method returns null. If the lock point is used in write mode, this method will return a SynchronizationPoint unblocked when read can start.

startReadAsync

public Async<NoException> startReadAsync(boolean returnNullIfReady)

To call when a thread wants to enter read mode. If the lock point is used in write mode, this method will return a SynchronizationPoint unblocked when read can start.

endRead

public void endRead()

To call when the thread leaves the read mode and release this lock point.

startWrite

public void startWrite()

To call when a thread wants to enter write mode. If the lock point is used in read mode, this method will block until it is released.

startWriteAsync

public Async<NoException> startWriteAsync()

To call when a thread wants to enter write mode. If write can start immediately, this method returns null. If the lock point is used in read mode, this method will return a SynchronizationPoint unblocked when write can start.

startWriteAsync

public Async<NoException> startWriteAsync(boolean returnNullIfReady)

To call when a thread wants to enter write mode. If write can start immediately, this method returns null. If the lock point is used in read mode, this method will return a SynchronizationPoint unblocked when write can start.

endWrite

public void endWrite()

To call when the thread leaves the write mode and release this lock point.

isUsed

public boolean isUsed()

Return true if there is currently neither reader or writer. Note that this does not mean starting operation won't block because between the call of this method and the call to a startXXX method, another thread may have called a startXXX method.