tkrzw::KeySignalBroker< KEYTYPE >::Waiter Class Reference

Handler to wait for the signal. More...

#include <tkrzw_thread_util.h>

Public Member Functions
	Waiter (KeySignalBroker *broker, const KEYTYPE &key)
	Constructor. More...
	~Waiter ()
	Destructor. More...
bool	Wait (double timeout=-1)
	Waits for a signal to happen. More...

Detailed Description

template<typename KEYTYPE>
class tkrzw::KeySignalBroker< KEYTYPE >::Waiter

Handler to wait for the signal.

The constructor should be called before checking the resource. Then, the Wait method should be called if the resource state doesn't satisfy the required condition.

Constructor & Destructor Documentation

Waiter()

template<typename KEYTYPE >

tkrzw::KeySignalBroker< KEYTYPE >::Waiter::Waiter	(	KeySignalBroker *	broker,
		const KEYTYPE &	key
	)

Constructor.

Parameters

broker	The broker object.
key	The key of the signal.

~Waiter()

template<typename KEYTYPE >

tkrzw::KeySignalBroker< KEYTYPE >::Waiter::~Waiter

Destructor.

Member Function Documentation

Wait()

template<typename KEYTYPE >

bool tkrzw::KeySignalBroker< KEYTYPE >::Waiter::Wait

(

double

timeout = -1

)

Waits for a signal to happen.

Parameters

timeout

The timeout in seconds to wait. Zero means no wait. Negative means unlimited.

Returns

True if successful or false on timeout.

This detects only signals which happen during this method is running. In other words, signals which were sent before the call are not ignored.