ACE_Tokens Class Reference

Abstract representation of ACE tokens. More...

#include <Local_Tokens.h>

Inheritance diagram for ACE_Tokens:

Collaboration diagram for ACE_Tokens:

Public Types
enum	TOKEN_TYPES { MUTEX , RWLOCK }
typedef ACE_Unbounded_Stack< ACE_TPQ_Entry * >	OWNER_STACK
	Stack of owners.

Public Member Functions
	ACE_Tokens ()
	Null constructor.
virtual	~ACE_Tokens ()=default
	Destructor.
virtual int	acquire (ACE_TPQ_Entry *caller, int ignore_deadlock, int notify)=0
	No implementation.
virtual int	tryacquire (ACE_TPQ_Entry *caller)=0
	No implementation.
virtual int	renew (ACE_TPQ_Entry *caller, int requeue_position)=0
	No implementation.
virtual int	release (ACE_TPQ_Entry *caller)=0
	No implementation.
void	make_owner (ACE_TPQ_Entry *caller)
void	remove (ACE_TPQ_Entry *caller)
	Remove the caller from the waiter list.
virtual int	owners (OWNER_STACK &o, const ACE_TCHAR *id)=0
virtual int	is_waiting_for (const ACE_TCHAR *id)=0
	Returns 1 if id is waiting for this token. 0 otherwise.
virtual int	is_owner (const ACE_TCHAR *id)=0
	Returns 1 if id is an owner of this token. 0 otherwise.
virtual ACE_Token_Proxy_Queue *	waiters ()
	Return the queue of waiters.
virtual int	no_of_waiters ()
const ACE_TCHAR *	owner_id ()
	The current owner.
const ACE_TCHAR *	name ()
	Token name.
void	inc_reference ()
int	dec_reference ()
void	dump () const
	Dump the state of the class.
virtual int	type () const =0
void	visit (int v)
	Mark or unmark the token as visited.
int	visited ()
	Check if the token has been visited.
ACE_TPQ_Entry *	owner ()
	All the data of the current owner.

Protected Attributes
int	visited_
	For the deadlock detection algorithm.
int	reference_count_
	Reference count.
ACE_Token_Proxy_Queue	waiters_
	List of client's owning and waiting the token.
ACE_TCHAR	token_name_ [ACE_MAXTOKENNAMELEN]
	Name of token.

Detailed Description

Abstract representation of ACE tokens.

Not a public interface. Currently, I don't see a reason for providing an abstract interface at this level of the library. As of yet, no one uses ACE_Tokens derivatives through this abstract interface except for ACE_Token_Manager. It only uses the statistical methods which are shared by all Tokens. For that reason, it still makes since to have a common base class. However, acquire, renew, and release do not need to have matching interfaces throughout all Tokens. To add a new type of token (e.g. semaphore), this class must be subtyped to define the new semantics. See ACE_Token_Manager for details.

Member Typedef Documentation

OWNER_STACK

typedef ACE_Unbounded_Stack<ACE_TPQ_Entry *> ACE_Tokens::OWNER_STACK

Stack of owners.

Member Enumeration Documentation

TOKEN_TYPES

enum ACE_Tokens::TOKEN_TYPES

These are the Token types supported by the library at ship time. There is no restriction on the number of Token types added by "3rd parties." These are only necessary for the Token Server.

Enumerator
MUTEX
RWLOCK

Constructor & Destructor Documentation

ACE_Tokens()

ACE_Tokens::ACE_Tokens

(

)

Null constructor.

~ACE_Tokens()

virtual ACE_Tokens::~ACE_Tokens ( )

virtualdefault

Destructor.

Member Function Documentation

acquire()

virtual int ACE_Tokens::acquire ( ACE_TPQ_Entry * caller, int ignore_deadlock, int notify )

pure virtual

No implementation.

Implemented in ACE_Mutex_Token, and ACE_RW_Token.

dec_reference()

int ACE_Tokens::dec_reference ( )

inline

dump()

void ACE_Tokens::dump

(

)

const

Dump the state of the class.

inc_reference()

void ACE_Tokens::inc_reference ( )

inline

is_owner()

virtual int ACE_Tokens::is_owner ( const ACE_TCHAR * id )

pure virtual

Returns 1 if id is an owner of this token. 0 otherwise.

Implemented in ACE_Mutex_Token, and ACE_RW_Token.

is_waiting_for()

virtual int ACE_Tokens::is_waiting_for ( const ACE_TCHAR * id )

pure virtual

Returns 1 if id is waiting for this token. 0 otherwise.

Implemented in ACE_Mutex_Token, and ACE_RW_Token.

make_owner()

void ACE_Tokens::make_owner

(

ACE_TPQ_Entry *

caller

)

Move the caller to the front of the waiter list. This is for use with remote mutexes and shadow mutexes.

name()

const ACE_TCHAR * ACE_Tokens::name ( )

inline

Token name.

no_of_waiters()

int ACE_Tokens::no_of_waiters ( )

virtual

Return the number of proxies that are currently waiting to get the token.

owner()

ACE_TPQ_Entry * ACE_Tokens::owner ( )

inline

All the data of the current owner.

owner_id()

const ACE_TCHAR * ACE_Tokens::owner_id ( )

inline

The current owner.

owners()

virtual int ACE_Tokens::owners ( OWNER_STACK & o, const ACE_TCHAR * id )

pure virtual

Returns a stack of the current owners. Returns -1 on error, 0 on success. If id is non-zero, returns 1 if id is an owner.

Implemented in ACE_Mutex_Token, and ACE_RW_Token.

release()

virtual int ACE_Tokens::release ( ACE_TPQ_Entry * caller )

pure virtual

No implementation.

Implemented in ACE_Mutex_Token, and ACE_RW_Token.

remove()

void ACE_Tokens::remove ( ACE_TPQ_Entry * caller )

inline

Remove the caller from the waiter list.

renew()

virtual int ACE_Tokens::renew ( ACE_TPQ_Entry * caller, int requeue_position )

pure virtual

No implementation.

Implemented in ACE_Mutex_Token, and ACE_RW_Token.

tryacquire()

virtual int ACE_Tokens::tryacquire ( ACE_TPQ_Entry * caller )

pure virtual

No implementation.

Implemented in ACE_Mutex_Token, and ACE_RW_Token.

type()

virtual int ACE_Tokens::type ( ) const

pure virtual

Provides a manual RTTI mechanism. This method is used only by ACE_Token_Request so that the type of a token can be sent to a remote Token Server.

Implemented in ACE_Mutex_Token, and ACE_RW_Token.

visit()

void ACE_Tokens::visit ( int v )

inline

Mark or unmark the token as visited.

visited()

int ACE_Tokens::visited ( )

inline

Check if the token has been visited.

waiters()

ACE_Token_Proxy_Queue * ACE_Tokens::waiters ( )

virtual

Return the queue of waiters.

Member Data Documentation

reference_count_

int ACE_Tokens::reference_count_

protected

Reference count.

token_name_

ACE_TCHAR ACE_Tokens::token_name_[ACE_MAXTOKENNAMELEN]

protected

Name of token.

visited_

int ACE_Tokens::visited_

protected

For the deadlock detection algorithm.

waiters_

ACE_Token_Proxy_Queue ACE_Tokens::waiters_

protected

List of client's owning and waiting the token.

---

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

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