EpcTools
An event based multi-threaded C++ development framework.
Public Member Functions | List of all members
ESemaphorePrivate Class Reference

Represents a private semaphore, the semaphore data is allocated from either the stack or heap. More...

#include <esynch.h>

Inheritance diagram for ESemaphorePrivate:
ESemaphoreBase

Public Member Functions

 ESemaphorePrivate (Long initcnt=0, Bool bInit=True)
 Class constructor. More...
 
 ~ESemaphorePrivate ()
 Class destructor. More...
 
Void init (Long initcnt)
 Initializes the data associated with the semaphore. More...
 
Void destroy ()
 Destroys the data associated with the semaphore. More...
 
- Public Member Functions inherited from ESemaphoreBase
 ESemaphoreBase ()
 Default constructor. More...
 
 ~ESemaphoreBase ()
 Class desctructor. More...
 
Bool Decrement (Bool wait=True)
 Decrements the semaphore value. More...
 
Bool Increment ()
 Increments the semaphore value. More...
 
Bool initialized ()
 Indicates the initialization status for this object. More...
 
Bool & shared ()
 Indicates if this object is to be shared between processes. More...
 
Long & initialCount ()
 Retrieves the initial semaphore value. More...
 
Long currCount ()
 Retrieves the current semaphore value. More...
 
 operator ESemaphoreData & ()
 Retrieves a reference to the underlying semaphore data. More...
 

Detailed Description

Represents a private semaphore, the semaphore data is allocated from either the stack or heap.

Constructor & Destructor Documentation

◆ ESemaphorePrivate()

ESemaphorePrivate::ESemaphorePrivate ( Long  initcnt = 0,
Bool  bInit = True 
)
inline

Class constructor.

Parameters
initcntthe initial count for the semaphore.
bInitdirects the constructor to initialize the semaphore.

◆ ~ESemaphorePrivate()

ESemaphorePrivate::~ESemaphorePrivate ( )
inline

Class destructor.

Member Function Documentation

◆ destroy()

Void ESemaphorePrivate::destroy ( )
inlinevirtual

Destroys the data associated with the semaphore.

Implements ESemaphoreBase.

◆ init()

Void ESemaphorePrivate::init ( Long  initcnt)
inlinevirtual

Initializes the data associated with the semaphore.

Parameters
initcntthe initial count for the semaphore.

Implements ESemaphoreBase.


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