de::gsi::bel::utils::Synch Class Reference

List of all members.

Public Member Functions

 Synch ()
long wait (int msec)
void trigger ()
void reset ()
long count ()
void setUserArg (Object userArg)
Object getUserArg ()

Detailed Description

Utility to synch between threads (wait and trigger). Works even if the Synch object was triggered before waiting thread was started. The triggers are counted. This is fine to signal thread A which started a thread B from thread B that it has become initialized.

Author:
huhmann


Constructor & Destructor Documentation

de::gsi::bel::utils::Synch::Synch (  )  [inline]

Create an Synch object with zero trigger count.


Member Function Documentation

long de::gsi::bel::utils::Synch::count (  )  [inline]

Get the trigger count.

Returns:
Trigger count.

Object de::gsi::bel::utils::Synch::getUserArg (  )  [inline]

Get the user object

Returns:
User object.

void de::gsi::bel::utils::Synch::reset (  )  [inline]

Resets the trigger count.

void de::gsi::bel::utils::Synch::setUserArg ( Object  userArg  )  [inline]

Set the user object of Synch object.

Parameters:
userArg User object to set.

void de::gsi::bel::utils::Synch::trigger (  )  [inline]

Triggers the synch object. The threads waiting for the synch object return from wait().

long de::gsi::bel::utils::Synch::wait ( int  msec  )  [inline]

Returns when sync object is triggered or was triggered in the past

Parameters:
msec wait for at most milliseconds
Returns:
number of triggers


The documentation for this class was generated from the following file:
Generated on 4 Mar 2014 for utilsjava by  doxygen 1.4.7