SourceMod SDK  1.7
SourceMod::IThreadHandle Class Referenceabstract

Describes a handle to a thread. More...

#include <public/IThreader.h>

Public Member Functions

virtual ~IThreadHandle ()
 
virtual bool WaitForThread ()=0
 Pauses parent thread until this thread completes. More...
 
virtual void DestroyThis ()=0
 Destroys the thread handle. This will not necessarily cancel the thread.
 
virtual IThreadCreatorParent ()=0
 Returns the parent threader. More...
 
virtual void GetParams (ThreadParams *ptparams)=0
 Returns the thread states. More...
 
virtual ThreadPriority GetPriority ()=0
 Returns the thread priority. More...
 
virtual bool SetPriority (ThreadPriority prio)=0
 Sets thread priority. NOTE: On Linux, this always returns false. More...
 
virtual ThreadState GetState ()=0
 Returns the thread state. More...
 
virtual bool Unpause ()=0
 Attempts to unpause a paused thread. More...
 

Detailed Description

Describes a handle to a thread.

Constructor & Destructor Documentation

virtual SourceMod::IThreadHandle::~IThreadHandle ( )
inlinevirtual

Virtual destructor

Member Function Documentation

virtual void SourceMod::IThreadHandle::GetParams ( ThreadParams ptparams)
pure virtual

Returns the thread states.

Parameters
ptparamsPointer to a ThreadParams buffer.
virtual ThreadPriority SourceMod::IThreadHandle::GetPriority ( )
pure virtual

Returns the thread priority.

Returns
Thread priority.
virtual ThreadState SourceMod::IThreadHandle::GetState ( )
pure virtual

Returns the thread state.

Returns
Current thread state.
virtual IThreadCreator* SourceMod::IThreadHandle::Parent ( )
pure virtual

Returns the parent threader.

Returns
IThreadCreator that created this thread.
virtual bool SourceMod::IThreadHandle::SetPriority ( ThreadPriority  prio)
pure virtual

Sets thread priority. NOTE: On Linux, this always returns false.

Parameters
prioThread priority to set.
Returns
True if successful, false otherwise.
virtual bool SourceMod::IThreadHandle::Unpause ( )
pure virtual

Attempts to unpause a paused thread.

Returns
True on success, false otherwise.
virtual bool SourceMod::IThreadHandle::WaitForThread ( )
pure virtual

Pauses parent thread until this thread completes.

Returns
True if successful, false otherwise.

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