SourceMod::IThreadHandle Class Reference

Describes a handle to a thread. More...

#include <public/IThreader.h>

List of all members.

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

---

Detailed Description

Describes a handle to a thread.

Definition at line 108 of file IThreader.h.

---

Constructor & Destructor Documentation

virtual SourceMod::IThreadHandle::~IThreadHandle

(

)

[inline, virtual]

Virtual destructor

Definition at line 112 of file IThreader.h.

---

Member Function Documentation

virtual bool SourceMod::IThreadHandle::WaitForThread

(

)

[pure virtual]

Pauses parent thread until this thread completes.

Returns:

True if successful, false otherwise.

virtual IThreadCreator* SourceMod::IThreadHandle::Parent

(

)

[pure virtual]

Returns the parent threader.

Returns:

IThreadCreator that created this thread.

virtual void SourceMod::IThreadHandle::GetParams

(

ThreadParams *

ptparams

)

[pure virtual]

Returns the thread states.

Parameters:

ptparams

Pointer to a ThreadParams buffer.

virtual ThreadPriority SourceMod::IThreadHandle::GetPriority

(

)

[pure virtual]

Returns the thread priority.

Returns:

Thread priority.

virtual bool SourceMod::IThreadHandle::SetPriority

(

ThreadPriority

prio

)

[pure virtual]

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

Parameters:

prio

Thread priority to set.

Returns:

True if successful, false otherwise.

virtual ThreadState SourceMod::IThreadHandle::GetState

(

)

[pure virtual]

Returns the thread state.

Returns:

Current thread state.

virtual bool SourceMod::IThreadHandle::Unpause

(

)

[pure virtual]

Attempts to unpause a paused thread.

Returns:

True on success, false otherwise.

---

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

• public/IThreader.h

---