ADTF
Loading...
Searching...
No Matches
adtf::services::ant::IKernel::IThread Class Referenceabstract

#include <kernel_intf.h>

Inherits adtf::ucom::ant::IObject.

Public Member Functions

 ADTF_IID (IThread, "thread.ant.kernel.services.adtf.iid")
 
virtual tResult Detach ()=0
 
virtual bool IsCurrent () const =0
 
virtual tResult Join (tTimeStamp nTimeout=-1)=0
 
- Public Member Functions inherited from adtf::ucom::ant::IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 

Protected Member Functions

 ~IThread ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 
- Protected Member Functions inherited from adtf::ucom::ant::IObject
 ~IObject ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 

Detailed Description

Interface for a thread.

Member Function Documentation

◆ Detach()

virtual tResult adtf::services::ant::IKernel::IThread::Detach ( )
pure virtual

Detaches the thread, which can then no longer be modified via this interface.

Returns
Standard result.

◆ IsCurrent()

virtual bool adtf::services::ant::IKernel::IThread::IsCurrent ( ) const
pure virtual

Returns whether this thread is the current thread of execution.

Returns
Whether this thread is the current thread of execution.

◆ Join()

virtual tResult adtf::services::ant::IKernel::IThread::Join ( tTimeStamp nTimeout = -1)
pure virtual

Blocks the current thread until this thread has exited.

Parameters
[in]nTimeoutThe timeout in microseconds. -1 = no timeout, 0 = non-blocking.
Return values
ERR_TIMEOUTThe timeout has expired.

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