ZeusBase-Library  2.0.4
zeus::IThreadManager Class Referenceabstract

#include <IThreadManager.hpp>

Inheritance diagram for zeus::IThreadManager:
zeus::IZUnknown zeus::TThreadManager

Public Member Functions

virtual void MQUALIFIER addThread (Uint uiID, IThreadMessageQueue &rQueue, bool bInterrupted)=0
 
virtual Uint MQUALIFIER getCurrentThreadID () const =0
 
virtual Retval MQUALIFIER getMessageQueue (Uint uiThreadID, IThreadMessageQueue *&rpQueue)=0
 
virtual bool MQUALIFIER isThreadInterrupted (Uint uiID) const =0
 
virtual void MQUALIFIER removeThread (Uint uiID)=0
 
virtual void MQUALIFIER setThreadState (Uint uiID, bool bInterrupted)=0
 
virtual Uint MQUALIFIER getMainThreadID () const =0
 
virtual Retval MQUALIFIER postObject (Uint uiThreadID, ISynchronizeObject &rObject, bool bWaitForCompletion)=0
 
virtual Retval MQUALIFIER postObjectToMainThread (ISynchronizeObject &rObject, bool bWaitForCompletion)=0
 
virtual bool MQUALIFIER isCurrentThread (Uint uiThreadID) const =0
 
virtual bool MQUALIFIER isCurrentMainThread () const =0
 
- Public Member Functions inherited from zeus::IZUnknown
virtual Retval MQUALIFIER askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)=0
 
virtual void MQUALIFIER addRef () const =0
 
virtual void MQUALIFIER release () const =0
 

Detailed Description

This interface defines the methods of the thread manager

Member Function Documentation

§ addThread()

virtual void MQUALIFIER zeus::IThreadManager::addThread ( Uint  uiID,
IThreadMessageQueue rQueue,
bool  bInterrupted 
)
pure virtual

adds a thread to the manager and registers the thread message queue

Parameters
uiID: Thread ID
rQueue: Thread message queue
bInterrupted: interrupted flag

Implemented in zeus::TThreadManager.

§ getCurrentThreadID()

virtual Uint MQUALIFIER zeus::IThreadManager::getCurrentThreadID ( ) const
pure virtual

Returns the current thread ID (calling thread)

Returns
Thread ID

Implemented in zeus::TThreadManager.

§ getMainThreadID()

virtual Uint MQUALIFIER zeus::IThreadManager::getMainThreadID ( ) const
pure virtual

Returns the ID of the main thread

Implemented in zeus::TThreadManager.

§ getMessageQueue()

virtual Retval MQUALIFIER zeus::IThreadManager::getMessageQueue ( Uint  uiThreadID,
IThreadMessageQueue *&  rpQueue 
)
pure virtual

Returns the thread message queue

Parameters
uiThreadID: ID of the queue owner thread
rpQueue: Return parameter
Return values
RET_NOERROR: Queue returned
RET_REQUEST_FAILED: Could not find a queue

Implemented in zeus::TThreadManager.

§ isCurrentMainThread()

virtual bool MQUALIFIER zeus::IThreadManager::isCurrentMainThread ( ) const
pure virtual

Checks if the current thread is the main thread

Implemented in zeus::TThreadManager.

§ isCurrentThread()

virtual bool MQUALIFIER zeus::IThreadManager::isCurrentThread ( Uint  uiThreadID) const
pure virtual

Checks if the current thread is the thread with ID uiThreadID.

Implemented in zeus::TThreadManager.

§ isThreadInterrupted()

virtual bool MQUALIFIER zeus::IThreadManager::isThreadInterrupted ( Uint  uiID) const
pure virtual

Checks if a thread is interrupted

Parameters
uiID: Thread ID
Return values
true: Thread is interrupted
falseThread is running

Implemented in zeus::TThreadManager.

§ postObject()

virtual Retval MQUALIFIER zeus::IThreadManager::postObject ( Uint  uiThreadID,
ISynchronizeObject rObject,
bool  bWaitForCompletion 
)
pure virtual

posts an object to a thread message queue

Parameters
uiThreadID: ID of the queue
rObject: Object to post
bWaitForCompletion: flag if the calling thread must wait for process completion

Implemented in zeus::TThreadManager.

§ postObjectToMainThread()

virtual Retval MQUALIFIER zeus::IThreadManager::postObjectToMainThread ( ISynchronizeObject rObject,
bool  bWaitForCompletion 
)
pure virtual

posts an object to the main thread message queue

Parameters
rObject: Object to post
bWaitForCompletion: flag if the calling thread must wait for process completion

Implemented in zeus::TThreadManager.

§ removeThread()

virtual void MQUALIFIER zeus::IThreadManager::removeThread ( Uint  uiID)
pure virtual

Removes a thread from the list

Parameters
uiID: Thread ID

Implemented in zeus::TThreadManager.

§ setThreadState()

virtual void MQUALIFIER zeus::IThreadManager::setThreadState ( Uint  uiID,
bool  bInterrupted 
)
pure virtual

Sets a new thread state

Parameters
uiID: Thread ID
bInterrupted: interrupted flag

Implemented in zeus::TThreadManager.


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


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Tue Sep 13 2016 22:31:40