pt.ua.concurrent

Class MutexCV

java.lang.Object

pt.ua.concurrent.CObject

pt.ua.concurrent.MutexCV

All Implemented Interfaces:

InterruptibleAwaitingThreads, SyncCV

public class MutexCV
extends CObject
implements SyncCV

Mutex condition variable class.

This class follows DbC(tm) methodology (Wikipedia). Where possible, contracts are implement with native's Java assert.

Version:

0.5, November 2011

Author:

Miguel Oliveira e Silva (mos@ua.pt)

Method Summary

Modifier and Type	Method and Description
void	await() Object's wait replacement, in which: - the checked exception InterruptedException, is replaced by the unchecked exception ThreadInterruptedException; - supports the registration of waiting threads for interrupt purposes.
boolean	await(long millis) Object's wait replacement, in which: - the checked exception InterruptedException, is replaced by the unchecked exception ThreadInterruptedException; - supports the registration of waiting threads for interrupt purposes; - timeout expiration can be tested using the method's result.
void	broadcast() Object's nofifyAll replacement.
boolean	lockIsMine() Is lock owned by me?
Mutex	mutex()
void	signal() Object's nofify replacement.

Methods inherited from class pt.ua.concurrent.CObject

await, interruptWaitingThreads, registerAwaitingThreads, syncronizedLockIsMine

Methods inherited from class java.lang.Object

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

Methods inherited from interface pt.ua.concurrent.InterruptibleAwaitingThreads

interruptWaitingThreads, registerAwaitingThreads

Method Detail

mutex

public Mutex mutex()

await

public void await()

Description copied from class: CObject

Object's wait replacement, in which:
- the checked exception InterruptedException, is replaced by the unchecked exception ThreadInterruptedException;
- supports the registration of waiting threads for interrupt purposes.

Precondition:

syncronizedLockIsMine() - native lock owned by me

Specified by:

await in interface SyncCV

Overrides:

await in class CObject

await

public boolean await(long millis)

Description copied from class: CObject

Object's wait replacement, in which:
- the checked exception InterruptedException, is replaced by the unchecked exception ThreadInterruptedException;
- supports the registration of waiting threads for interrupt purposes; - timeout expiration can be tested using the method's result. Important: Unlike Object's timed wait methods, CObject's timeout await methods require a non-zero timeout.

Precondition:

millis >= 0 - non negative timeout

syncronizedLockIsMine() - native lock owned by me

Overrides:

await in class CObject

Parameters:

millis - timeout (in milliseconds)

Returns:

false if await terminated due to a timeout expiration, true otherwise

signal

public void signal()

Description copied from class: CObject

Object's nofify replacement.

Precondition:

syncronizedLockIsMine() - native lock owned by me

Specified by:

signal in interface SyncCV

Overrides:

signal in class CObject

broadcast

public void broadcast()

Description copied from class: CObject

Object's nofifyAll replacement.

Precondition:

syncronizedLockIsMine() - native lock owned by me

Specified by:

broadcast in interface SyncCV

Overrides:

broadcast in class CObject

lockIsMine

public boolean lockIsMine()

Description copied from class: CObject

Is lock owned by me?

Specified by:

lockIsMine in interface SyncCV

Overrides:

lockIsMine in class CObject

Returns:

true, if lock is mine