RobotRaconteur::IRobotRaconteurMonitorObject Class Reference

Service object monitor lock notification. More...

#include <Service.h>

Public Member Functions
virtual void	RobotRaconteurMonitorEnter ()=0
	Request a thread-exclusive lock without timeout.
virtual void	RobotRaconteurMonitorEnter (int32_t timeout)=0
	Request a thread-exclusive lock with timeout.
virtual void	RobotRaconteurMonitorExit ()=0
	Release the thread-exclusive monitor lock.

Detailed Description

Service object monitor lock notification.

Service objects must implement IRobotRaconteurMonitorObject for monitor locking to function. Services call RobotRaconteurMonitorEnter() with an optional timeout to request the lock, and call RobotRaconteurMonitorExit() to release the monitor lock. RobotRaconteurMonitorEnter() should block until a thread-exclusive lock can be established.

Member Function Documentation

RobotRaconteurMonitorEnter() [1/2]

virtual void RobotRaconteur::IRobotRaconteurMonitorObject::RobotRaconteurMonitorEnter ( )

pure virtual

Request a thread-exclusive lock without timeout.

May block until lock can be established

RobotRaconteurMonitorEnter() [2/2]

virtual void RobotRaconteur::IRobotRaconteurMonitorObject::RobotRaconteurMonitorEnter ( int32_t timeout )

pure virtual

Request a thread-exclusive lock with timeout.

May block until lock can be established, up to the specified timeout.

Parameters

timeout

Lock request timeout in milliseconds

---

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/Service.h