ADTF
IKernel::IThreadabstract

Interface for a thread. More...

Inheritance diagram for IKernel::IThread:
[legend]

Public Member Functions

 ADTF_IID (IThread, "thread.ant.kernel.services.adtf.iid")
 
virtual tResult Detach ()=0
 Detaches the thread, which can then no longer be modified via this interface. More...
 
virtual bool IsCurrent () const =0
 Returns whether this thread is the current thread of execution. More...
 
virtual tResult Join (tTimeStamp nTimeout=-1)=0
 Blocks the current thread until this thread has exited. More...
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast() More...
 

Protected Member Functions

 ~IThread ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 

Detailed Description

Interface for a thread.

Definition at line 146 of file kernel_intf.h.

Member Function Documentation

◆ Detach()

virtual tResult Detach ( )
pure virtual

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

Returns
Standard result.

◆ IsCurrent()

virtual bool 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 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.