pt.ua.concurrent

Class Metronome

java.lang.Object

pt.ua.concurrent.Metronome

public class Metronome
extends java.lang.Object

This class implements an active (thread) metronome class, able to periodically synchronize any * number of threads.

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

Version:

0.5, December 2015

Author:

Miguel Oliveira e Silva (mos@ua.pt)

Constructor Summary

Constructors

Constructor and Description
Metronome(long clockPeriod) Constructs a new metronome with a specified time period.

Method Summary

Modifier and Type	Method and Description
boolean	active() Is current metronome still active?
long	sync() Caller will wait until the next metronome tick.
void	terminate() Terminate current metronome.

Methods inherited from class java.lang.Object

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

Constructor Detail

Metronome

public Metronome(long clockPeriod)

Constructs a new metronome with a specified time period.

Precondition:

clockPeriod > 0L

Parameters:

clockPeriod - the metronome's period in milliseconds

Method Detail

active

public boolean active()

Is current metronome still active?

Returns:

true, if active, false otherwise

sync

public long sync()

Caller will wait until the next metronome tick.

Returns:

number of ticks so far

terminate

public void terminate()

Terminate current metronome.

Postcondition:

!active()