RobotRaconteur::AutoResetEvent Class Reference

Synchronization event for thread synchronization. Resets automatically after being triggered. More...

#include <AutoResetEvent.h>

Public Member Functions
virtual void	Set ()
	Set the event, releasing waiting threads.
virtual void	Reset ()
	Reset the event.
virtual void	WaitOne ()
	Block the current thread infinitely until Set() is called.
virtual bool	WaitOne (int32_t timeout)
	Block the current thread until Set() is called, or timeout expires.

Detailed Description

Synchronization event for thread synchronization. Resets automatically after being triggered.

Construct using RobotRaconteurNode::CreateAutoResetEvent()

Member Function Documentation

WaitOne()

virtual bool RobotRaconteur::AutoResetEvent::WaitOne ( int32_t timeout )

virtual

Block the current thread until Set() is called, or timeout expires.

Timeout is based on the RobotRaconteurNode time provider

Parameters

timeout

The timeout in milliseconds

Returns

true Set() was called

false The wait timed out

---

The documentation for this class was generated from the following file:

• /builddir/build/BUILD/robotraconteur-1.2.8-build/RobotRaconteur-1.2.8-Source/RobotRaconteurCore/include/RobotRaconteur/AutoResetEvent.h