rc_mutex Class Reference

#include <rc_mutex.h>

Inheritance diagram for rc_mutex:

List of all members.

---

Detailed Description

Resettable representation of sc_mutex.

Definition at line 47 of file rc_mutex.h.

Public Member Functions
	rc_mutex ()
	rc_mutex (const char *name_)
virtual const char *	kind () const
virtual int	lock ()
virtual int	trylock ()
virtual int	unlock ()
Protected Member Functions
virtual void	rc_on_reset ()
	Called to request the object for an immediate reset.
bool	is_locked () const
Protected Attributes
sc_process_handle	m_lock_owner
sc_event	m_free
Private Member Functions
	rc_mutex (const rc_mutex &other)
rc_mutex &	operator= (const rc_mutex &other)

---

Constructor & Destructor Documentation

rc_mutex

(

)

Definition at line 41 of file rc_mutex.cpp.

rc_mutex

(

const char *

name_

)

[explicit]

Definition at line 45 of file rc_mutex.cpp.

rc_mutex

(

const rc_mutex &

other

)

[private]

---

Member Function Documentation

virtual const char* kind

(

)

const [inline, virtual]

Definition at line 57 of file rc_mutex.h.

int lock

(

)

[virtual]

Definition at line 58 of file rc_mutex.cpp.

int trylock

(

)

[virtual]

Definition at line 67 of file rc_mutex.cpp.

int unlock

(

)

[virtual]

Definition at line 76 of file rc_mutex.cpp.

void rc_on_reset

(

)

[protected, virtual]

Called to request the object for an immediate reset.

rc_on_reset() is called every time a rc_reconfigurable is activated or deactivated during simulation phase, i.e. normally it will be called twice. An implementation is free to only reset itself either at activation or deactivation.

Attention:

An implementation of this method shall not invoke any wait statements.

Note:

Method should be declared to be "protected".

Implements rc_resettable.

Definition at line 49 of file rc_mutex.cpp.

bool is_locked

(

)

const [inline, protected]

Definition at line 70 of file rc_mutex.h.

rc_mutex& operator=

(

const rc_mutex &

other

)

[private]

---

Member Data Documentation

sc_process_handle m_lock_owner [protected]

Definition at line 75 of file rc_mutex.h.

Referenced by rc_mutex::is_locked(), rc_mutex::lock(), rc_mutex::rc_on_reset(), rc_mutex::trylock(), and rc_mutex::unlock().

sc_event m_free [protected]

Definition at line 76 of file rc_mutex.h.

Referenced by rc_mutex::lock(), rc_mutex::rc_on_reset(), and rc_mutex::unlock().

---

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

• rc_mutex.h
• rc_mutex.cpp

---