ACE_TPQ_Entry Class Reference

Token Proxy Queue entry. Used in the ACE_Token_Proxy_Queue. More...

#include <Local_Tokens.h>

Inheritance diagram for ACE_TPQ_Entry:

Collaboration diagram for ACE_TPQ_Entry:

Public Types
typedef void(*	PTVF) (void *)

Public Member Functions
	ACE_TPQ_Entry ()
	Null constructor.
	ACE_TPQ_Entry (const ACE_Token_Proxy *proxy, const ACE_TCHAR *client_id)
	Constructor.
	ACE_TPQ_Entry (const ACE_TPQ_Entry &rhs)
	Copy constructor.
	~ACE_TPQ_Entry ()
	Destructor.
void	operator= (const ACE_TPQ_Entry &rhs)
	Copy operator use by the queue.
ACE_Token_Proxy *	proxy () const
	Get top of the queue.
void	proxy (ACE_Token_Proxy *)
	Set top of the queue.
int	nesting_level () const
	Get nesting level of the entry.
void	nesting_level (int delta)
	Delta nesting level of the entry.
const ACE_TCHAR *	client_id () const
	Get client_id of the entry.
void	client_id (const ACE_TCHAR *)
	Set client_id of the entry.
int	equal_client_id (const ACE_TCHAR *id)
	Returns 1 if id == client id. Does not check for id == 0.
void	set (void(*sleep_hook)(void *))
	One method for arg and sleep_hook.
void	sleep_hook (void(*sh)(void *))
	Set sleep hook of the entry.
PTVF	sleep_hook () const
	Get sleep hook of the entry.
void	call_sleep_hook ()
	Call the sleep hook function or method passing arg.
void	dump () const
	Dump the state of the class.
int	waiting () const
	Get whether this client is blocked waiting for a token.
void	waiting (int w)
	Set whether this client is blocked waiting for a token.

Public Attributes
ACE_TOKEN_CONST::COND_VAR	cond_var_
ACE_TOKEN_CONST::MUTEX	lock_
ACE_TPQ_Entry *	next_
	Pointer to next in list.

Private Attributes
int	waiting_
	This client is waiting for a token.
ACE_Token_Proxy *	proxy_
	Proxy.
int	nesting_level_
	Nesting level.
void *	arg_
	Arg.
ACE_TCHAR	client_id_ [ACE_MAXCLIENTIDLEN]
	Client id.
void(*	sleep_hook_ )(void *)
	Sleep hook.

Friends
class	ACE_Token_Manager

Detailed Description

Token Proxy Queue entry. Used in the ACE_Token_Proxy_Queue.

Not a public interface.

Member Typedef Documentation

PTVF

typedef void(* ACE_TPQ_Entry::PTVF) (void *)

Constructor & Destructor Documentation

ACE_TPQ_Entry() [1/3]

ACE_TPQ_Entry::ACE_TPQ_Entry

(

)

Null constructor.

ACE_TPQ_Entry() [2/3]

ACE_TPQ_Entry::ACE_TPQ_Entry	(	const ACE_Token_Proxy *	proxy,
		const ACE_TCHAR *	client_id )

Constructor.

ACE_TPQ_Entry() [3/3]

ACE_TPQ_Entry::ACE_TPQ_Entry

(

const ACE_TPQ_Entry &

rhs

)

Copy constructor.

~ACE_TPQ_Entry()

ACE_TPQ_Entry::~ACE_TPQ_Entry

(

)

Destructor.

Member Function Documentation

call_sleep_hook()

void ACE_TPQ_Entry::call_sleep_hook ( )

inline

Call the sleep hook function or method passing arg.

client_id() [1/2]

const ACE_TCHAR * ACE_TPQ_Entry::client_id ( ) const

inline

Get client_id of the entry.

client_id() [2/2]

void ACE_TPQ_Entry::client_id

(

const ACE_TCHAR *

id

)

Set client_id of the entry.

dump()

void ACE_TPQ_Entry::dump

(

)

const

Dump the state of the class.

equal_client_id()

int ACE_TPQ_Entry::equal_client_id ( const ACE_TCHAR * id )

inline

Returns 1 if id == client id. Does not check for id == 0.

nesting_level() [1/2]

int ACE_TPQ_Entry::nesting_level ( ) const

inline

Get nesting level of the entry.

nesting_level() [2/2]

void ACE_TPQ_Entry::nesting_level ( int delta )

inline

Delta nesting level of the entry.

operator=()

void ACE_TPQ_Entry::operator=

(

const ACE_TPQ_Entry &

rhs

)

Copy operator use by the queue.

proxy() [1/2]

ACE_Token_Proxy * ACE_TPQ_Entry::proxy ( ) const

inline

Get top of the queue.

proxy() [2/2]

void ACE_TPQ_Entry::proxy ( ACE_Token_Proxy * proxy )

inline

Set top of the queue.

set()

void ACE_TPQ_Entry::set

(

void(*)(void *)

sleep_hook

)

One method for arg and sleep_hook.

sleep_hook() [1/2]

ACE_TPQ_Entry::PTVF ACE_TPQ_Entry::sleep_hook ( ) const

inline

Get sleep hook of the entry.

sleep_hook() [2/2]

void ACE_TPQ_Entry::sleep_hook ( void(*)(void *) sh )

inline

Set sleep hook of the entry.

waiting() [1/2]

int ACE_TPQ_Entry::waiting ( ) const

inline

Get whether this client is blocked waiting for a token.

waiting() [2/2]

void ACE_TPQ_Entry::waiting ( int w )

inline

Set whether this client is blocked waiting for a token.

Friends And Related Symbol Documentation

ACE_Token_Manager

friend class ACE_Token_Manager

friend

Member Data Documentation

arg_

void* ACE_TPQ_Entry::arg_

private

Arg.

client_id_

ACE_TCHAR ACE_TPQ_Entry::client_id_[ACE_MAXCLIENTIDLEN]

private

Client id.

cond_var_

ACE_TOKEN_CONST::COND_VAR ACE_TPQ_Entry::cond_var_

lock_

ACE_TOKEN_CONST::MUTEX ACE_TPQ_Entry::lock_

nesting_level_

int ACE_TPQ_Entry::nesting_level_

private

Nesting level.

next_

ACE_TPQ_Entry* ACE_TPQ_Entry::next_

Pointer to next in list.

proxy_

ACE_Token_Proxy* ACE_TPQ_Entry::proxy_

private

Proxy.

sleep_hook_

void(* ACE_TPQ_Entry::sleep_hook_) (void *)

private

Sleep hook.

waiting_

int ACE_TPQ_Entry::waiting_

private

This client is waiting for a token.

---

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

• Local_Tokens.h
• Local_Tokens.cpp
• Local_Tokens.inl