wxThread

Methods

• wxThread
  This constructor creates a new detached (default) or joinable C++ thread object.
• Create
  Creates a new thread.
• Delete
  Calling Delete() gracefully terminates a detached thread, either when the thread calls TestDestroy() or when it finishes processing.
• Entry
  This is the entry point of the thread.
• GetId
  Gets the thread identifier: this is a platform dependent number that uniquely identifies the thread throughout the system during its existence (i.e.
• GetKind
  Returns the thread kind as it was given in the ctor.
• GetPriority
  Gets the priority of the thread, between zero and 100.
• IsAlive
  Returns true if the thread is alive (i.e.
• IsDetached
  Returns true if the thread is of the detached kind, false if it is a joinable one.
• IsPaused
  Returns true if the thread is paused.
• IsRunning
  Returns true if the thread is running.
• Kill
  Immediately terminates the target thread.
• Pause
  Suspends the thread.
• Resume
  Resumes a thread suspended by the call to Pause().
• Run
  Starts the thread execution.
• SetPriority
  Sets the priority of the thread, between 0 and 100.
• TestDestroy
  This function should be called periodically by the thread to ensure that calls to Pause() and Delete() will work.
• Wait
  Waits for a joinable thread to terminate and returns the value the thread returned from Entry() or "(ExitCode)-1" on error.

Static Methods

• GetCPUCount
  Returns the number of system CPUs or -1 if the value is unknown.
• GetCurrentId
  Returns the platform specific thread ID of the current thread as a long.
• GetMainId
  Returns the thread ID of the main thread.
• IsMain
  Returns true if the calling thread is the main application thread.
• SetConcurrency
  Sets the thread concurrency level for this process.
• Sleep
  Pauses the thread execution for the given amount of time.
• This
  Return the thread object for the calling thread.
• Yield
  Give the rest of the thread's time-slice to the system allowing the other threads to run.

wxThread

wxThread ( wxThreadKind $kind=wxTHREAD_DETACHED )

This constructor creates a new detached (default) or joinable C++ thread object.

Create

wxThreadError Create ( integer $stackSize )

Creates a new thread.

Delete

wxThreadError Delete ( =NULL, wxThreadWait $waitMode=wxTHREAD_WAIT_BLOCK )

Calling Delete() gracefully terminates a detached thread, either when the thread calls TestDestroy() or when it finishes processing.

Entry

Entry ( )

This is the entry point of the thread.

GetCPUCount

static integer GetCPUCount ( )

Returns the number of system CPUs or -1 if the value is unknown.

GetCurrentId

static integer GetCurrentId ( )

Returns the platform specific thread ID of the current thread as a long.

GetId

integer GetId ( )

Gets the thread identifier: this is a platform dependent number that uniquely identifies the thread throughout the system during its existence (i.e.

GetKind

wxThreadKind GetKind ( )

Returns the thread kind as it was given in the ctor.

GetMainId

static integer GetMainId ( )

Returns the thread ID of the main thread.

GetPriority

integer GetPriority ( )

Gets the priority of the thread, between zero and 100.

IsAlive

bool IsAlive ( )

Returns true if the thread is alive (i.e.

IsDetached

bool IsDetached ( )

Returns true if the thread is of the detached kind, false if it is a joinable one.

IsMain

static bool IsMain ( )

Returns true if the calling thread is the main application thread.

IsPaused

bool IsPaused ( )

Returns true if the thread is paused.

IsRunning

bool IsRunning ( )

Returns true if the thread is running.

Kill

wxThreadError Kill ( )

Immediately terminates the target thread.

Pause

wxThreadError Pause ( )

Suspends the thread.

Resume

wxThreadError Resume ( )

Resumes a thread suspended by the call to Pause().

Run

wxThreadError Run ( )

Starts the thread execution.

SetConcurrency

static bool SetConcurrency ( integer $level )

Sets the thread concurrency level for this process.

SetPriority

SetPriority ( integer $priority )

Sets the priority of the thread, between 0 and 100.

Sleep

static Sleep ( integer $milliseconds )

Pauses the thread execution for the given amount of time.

TestDestroy

bool TestDestroy ( )

This function should be called periodically by the thread to ensure that calls to Pause() and Delete() will work.

This

static wxThread& This ( )

Return the thread object for the calling thread.

Wait

Wait ( wxThreadWait $flags=wxTHREAD_WAIT_BLOCK )

Waits for a joinable thread to terminate and returns the value the thread returned from Entry() or "(ExitCode)-1" on error.

Yield

static Yield ( )

Give the rest of the thread's time-slice to the system allowing the other threads to run.