#include <vrpn_Mutex.h>

Inheritance diagram for vrpn_Mutex_Remote:

Collaboration diagram for vrpn_Mutex_Remote:

[legend]

Classes
struct	mutexCallback

Public Member Functions
	vrpn_Mutex_Remote (const char name, vrpn_Connection =NULL)

virtual	~vrpn_Mutex_Remote (void)

vrpn_bool	isAvailable (void) const
	True from when release() is called or we receive a release message from another process until request() is called or we grant the lock to another process in response to its request message.

vrpn_bool	isHeldLocally (void) const
	True from when RequestGranted callbacks are triggered until release() is called.

vrpn_bool	isHeldRemotely (void) const
	True from when we grant the lock to another process in response to its request message until we receive a release message from another process.

void	request (void)
	Request the distributed lock. Does not request the lock if !isAvailable(), instead automatically triggering DeniedCallbacks.

void	release (void)
	Release the distributed lock. Does nothing if !isHeldLocally() and there isn't a request pending.

vrpn_bool	addRequestGrantedCallback (void userdata, int()(void *))
	These callbacks are triggered when OUR request is granted.

vrpn_bool	addRequestDeniedCallback (void userdata, int()(void *))
	These callbacks are triggered when OUR request is denied.

vrpn_bool	addTakeCallback (void userdata, int()(void *))
	These callbacks are triggered when ANY peer gets the mutex.

vrpn_bool	addReleaseCallback (void userdata, int()(void *))
	These callbacks are triggered when ANY peer releases the mutex.

Public Member Functions inherited from vrpn_Mutex
	vrpn_Mutex (const char name, vrpn_Connection =NULL)

virtual	~vrpn_Mutex (void)=0

void	mainloop (void)

Protected Types
enum	state { OURS , REQUESTING , AVAILABLE , HELD_REMOTELY }

Protected Member Functions
void	requestIndex (void)

void	triggerGrantCallbacks (void)

void	triggerDenyCallbacks (void)

void	triggerTakeCallbacks (void)

void	triggerReleaseCallbacks (void)

Protected Member Functions inherited from vrpn_Mutex
void	sendRequest (vrpn_int32 index)

void	sendRelease (void)

void	sendReleaseNotification (void)

void	sendGrantRequest (vrpn_int32 index)

void	sendDenyRequest (vrpn_int32 index)

Static Protected Member Functions
static int VRPN_CALLBACK	handle_grantRequest (void *, vrpn_HANDLERPARAM)

static int VRPN_CALLBACK	handle_denyRequest (void *, vrpn_HANDLERPARAM)

static int VRPN_CALLBACK	handle_releaseNotification (void *, vrpn_HANDLERPARAM)

static int VRPN_CALLBACK	handle_initialize (void *, vrpn_HANDLERPARAM)

static int VRPN_CALLBACK	handle_gotConnection (void *, vrpn_HANDLERPARAM)

Protected Attributes
state	d_state

vrpn_int32	d_myIndex

vrpn_bool	d_requestBeforeInit

mutexCallback *	d_reqGrantedCB

mutexCallback *	d_reqDeniedCB

mutexCallback *	d_takeCB

mutexCallback *	d_releaseCB

Protected Attributes inherited from vrpn_Mutex
vrpn_Connection *	d_connection

vrpn_int32	d_myId

vrpn_int32	d_requestIndex_type

vrpn_int32	d_requestMutex_type

vrpn_int32	d_release_type

vrpn_int32	d_releaseNotification_type

vrpn_int32	d_grantRequest_type

vrpn_int32	d_denyRequest_type

vrpn_int32	d_initialize_type

Detailed Description

Definition at line 70 of file vrpn_Mutex.h.

Member Enumeration Documentation

◆ state

enum vrpn_Mutex_Remote::state

protected

Enumerator
OURS
REQUESTING
AVAILABLE
HELD_REMOTELY

Definition at line 114 of file vrpn_Mutex.h.

Constructor & Destructor Documentation

◆ vrpn_Mutex_Remote()

vrpn_Mutex_Remote::vrpn_Mutex_Remote	(	const char *	name,
		vrpn_Connection *	c = NULL )

Definition at line 372 of file vrpn_Mutex.C.

References AVAILABLE, vrpn_Mutex::d_connection, vrpn_Mutex::d_denyRequest_type, vrpn_Mutex::d_grantRequest_type, vrpn_Mutex::d_initialize_type, d_myIndex, d_releaseCB, vrpn_Mutex::d_releaseNotification_type, d_reqDeniedCB, d_reqGrantedCB, d_requestBeforeInit, d_state, d_takeCB, handle_denyRequest(), handle_gotConnection(), handle_grantRequest(), handle_initialize(), handle_releaseNotification(), requestIndex(), vrpn_Connection, vrpn_get_connection_by_name(), vrpn_got_connection, and vrpn_Mutex::vrpn_Mutex().

Referenced by handle_denyRequest(), handle_gotConnection(), handle_grantRequest(), handle_initialize(), and handle_releaseNotification().

Here is the call graph for this function:

◆ ~vrpn_Mutex_Remote()

vrpn_Mutex_Remote::~vrpn_Mutex_Remote ( void )

virtual

Definition at line 404 of file vrpn_Mutex.C.

References vrpn_Mutex::d_connection, vrpn_Mutex::d_denyRequest_type, vrpn_Mutex::d_grantRequest_type, vrpn_Mutex::d_initialize_type, vrpn_Mutex::d_releaseNotification_type, handle_denyRequest(), handle_gotConnection(), handle_grantRequest(), handle_initialize(), handle_releaseNotification(), release(), and vrpn_got_connection.

Here is the call graph for this function:

Member Function Documentation

◆ addReleaseCallback()

vrpn_bool vrpn_Mutex_Remote::addReleaseCallback	(	void *	userdata,
		int(*	f )(void *) )

These callbacks are triggered when ANY peer releases the mutex.

Definition at line 569 of file vrpn_Mutex.C.

References d_releaseCB, vrpn_Mutex_Remote::mutexCallback::f, vrpn_Mutex_Remote::mutexCallback::next, and vrpn_Mutex_Remote::mutexCallback::userdata.

◆ addRequestDeniedCallback()

vrpn_bool vrpn_Mutex_Remote::addRequestDeniedCallback	(	void *	userdata,
		int(*	f )(void *) )

These callbacks are triggered when OUR request is denied.

Definition at line 533 of file vrpn_Mutex.C.

References d_reqDeniedCB, vrpn_Mutex_Remote::mutexCallback::f, vrpn_Mutex_Remote::mutexCallback::next, and vrpn_Mutex_Remote::mutexCallback::userdata.

◆ addRequestGrantedCallback()

vrpn_bool vrpn_Mutex_Remote::addRequestGrantedCallback	(	void *	userdata,
		int(*	f )(void *) )

These callbacks are triggered when OUR request is granted.

Definition at line 515 of file vrpn_Mutex.C.

References d_reqGrantedCB, vrpn_Mutex_Remote::mutexCallback::f, vrpn_Mutex_Remote::mutexCallback::next, and vrpn_Mutex_Remote::mutexCallback::userdata.

◆ addTakeCallback()

vrpn_bool vrpn_Mutex_Remote::addTakeCallback	(	void *	userdata,
		int(*	f )(void *) )

These callbacks are triggered when ANY peer gets the mutex.

Definition at line 551 of file vrpn_Mutex.C.

References d_takeCB, vrpn_Mutex_Remote::mutexCallback::f, vrpn_Mutex_Remote::mutexCallback::next, and vrpn_Mutex_Remote::mutexCallback::userdata.

◆ handle_denyRequest()

int vrpn_Mutex_Remote::handle_denyRequest	(	void *	userdata,
		vrpn_HANDLERPARAM	p )

staticprotected

Definition at line 613 of file vrpn_Mutex.C.

References vrpn_HANDLERPARAM::buffer, d_myIndex, d_state, HELD_REMOTELY, triggerDenyCallbacks(), vrpn_Mutex_Remote(), and vrpn_unbuffer().

Referenced by vrpn_Mutex_Remote(), and ~vrpn_Mutex_Remote().

Here is the call graph for this function:

◆ handle_gotConnection()

int vrpn_Mutex_Remote::handle_gotConnection	(	void *	userdata,
		vrpn_HANDLERPARAM	)

staticprotected

Definition at line 714 of file vrpn_Mutex.C.

References d_myIndex, requestIndex(), and vrpn_Mutex_Remote().

Referenced by vrpn_Mutex_Remote(), and ~vrpn_Mutex_Remote().

Here is the call graph for this function:

◆ handle_grantRequest()

int vrpn_Mutex_Remote::handle_grantRequest	(	void *	userdata,
		vrpn_HANDLERPARAM	p )

staticprotected

Definition at line 587 of file vrpn_Mutex.C.

References vrpn_HANDLERPARAM::buffer, d_myIndex, d_state, HELD_REMOTELY, OURS, triggerGrantCallbacks(), triggerTakeCallbacks(), vrpn_Mutex_Remote(), and vrpn_unbuffer().

Referenced by vrpn_Mutex_Remote(), and ~vrpn_Mutex_Remote().

Here is the call graph for this function:

◆ handle_initialize()

int vrpn_Mutex_Remote::handle_initialize	(	void *	userdata,
		vrpn_HANDLERPARAM	p )

staticprotected

Definition at line 652 of file vrpn_Mutex.C.

References vrpn_HANDLERPARAM::buffer, d_myIndex, d_requestBeforeInit, vrpn_HANDLERPARAM::payload_len, request(), vrpn_Mutex_Remote(), and vrpn_unbuffer().

Referenced by vrpn_Mutex_Remote(), and ~vrpn_Mutex_Remote().

Here is the call graph for this function:

◆ handle_releaseNotification()

int vrpn_Mutex_Remote::handle_releaseNotification	(	void *	userdata,
		vrpn_HANDLERPARAM	)

staticprotected

Definition at line 636 of file vrpn_Mutex.C.

References AVAILABLE, d_state, triggerReleaseCallbacks(), and vrpn_Mutex_Remote().

Referenced by vrpn_Mutex_Remote(), and ~vrpn_Mutex_Remote().

Here is the call graph for this function:

◆ isAvailable()

vrpn_bool vrpn_Mutex_Remote::isAvailable ( void ) const

True from when release() is called or we receive a release message from another process until request() is called or we grant the lock to another process in response to its request message.

Definition at line 425 of file vrpn_Mutex.C.

References AVAILABLE, and d_state.

Referenced by request().