Thread

class Thread

Bases: TypedReferenceCount, Namable

Due to a GCC bug, we can’t use alignas() together with an attribute.

Inheritance diagram

digraph inheritanceddf458e52f { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; "Namable" [URL="acron.core.Namable.html#acron.core.Namable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "Namable" [arrowsize=0.75,style=""]; "ReferenceCount" [URL="acron.core.ReferenceCount.html#acron.core.ReferenceCount",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "ReferenceCount" [arrowsize=0.75,style=""]; "Thread" [URL="acron.core.Thread.html#acron.core.Thread",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="// Due to a GCC bug, we can't use alignas() together with an attribute."]; "TypedReferenceCount" -> "Thread" [arrowsize=0.75,style=""]; "Namable" -> "Thread" [arrowsize=0.75,style=""]; "TypedObject" [URL="acron.core.TypedObject.html#acron.core.TypedObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "TypedObject" [arrowsize=0.75,style=""]; "TypedReferenceCount" [URL="acron.core.TypedReferenceCount.html#acron.core.TypedReferenceCount",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedObject" -> "TypedReferenceCount" [arrowsize=0.75,style=""]; "ReferenceCount" -> "TypedReferenceCount" [arrowsize=0.75,style=""]; }

static Thread.bind_thread()

Returns a new Acron Thread object associated with the current thread (which has been created externally). This can be used to bind a unique Acron Thread object with an external thread, such as a new Python thread.

It is particularly useful to bind a Acron Thread object to an external thread for the purposes of PStats monitoring. Without this call, each external thread will be assigned the same global ExternalThread object, which means they will all appear in the same PStats graph.

It is the caller’s responsibility to save the returned Thread pointer for the lifetime of the external thread. It is an error for the Thread pointer to destruct while the external thread is still in the system.

It is also an error to call this method from the main thread, or twice within a given thread, unless it is given the same name each time (in which case the same pointer will be returned each time).

static Thread.consider_yield()

Possibly suspends the current thread for the rest of the current epoch, if it has run for enough this epoch. This is especially important for the simple thread implementation, which relies on cooperative yields like this.

static Thread.force_yield()

Suspends the current thread for the rest of the current epoch.

static Thread.get_class_type()

static Thread.get_context_switches()

Returns thread statistics. The first number is the total number of context switches reported by the OS, and the second number is the number of involuntary context switches (ie. the thread was scheduled out by the OS), if known.

static Thread.get_current_pipeline_stage()

Returns the integer pipeline stage associated with the current thread. This is the same thing as get_current_thread()->get_pipeline_stage(), but it may be faster to retrieve in some contexts.

Thread.get_current_task()

Returns the task currently executing on this thread (via the AsyncTaskManager), if any, or NULL if the thread is not currently servicing a task.

static Thread.get_current_thread()

Returns a pointer to the currently-executing Thread object. If this is called from the main thread, this will return the same value as get_main_thread().

This will always return some valid Thread pointer. It will never return NULL, even if the current thread was spawned outside of Acron’s threading system, although all non-Acron threads will return the exact same Thread pointer.

static Thread.get_external_thread()

Returns a pointer to the “external” Thread object–this is a special Thread object that corresponds to any thread spawned outside of Acron’s threading interface. Note that multiple different threads may share this same pointer.

static Thread.get_main_thread()

Returns a pointer to the “main” Thread object–this is the Thread that started the whole process.

Thread.get_pipeline_stage()

Returns the Pipeline stage number associated with this thread. The default stage is 0 if no stage is specified otherwise. See set_pipeline_stage().

Thread.get_pstats_index()

Returns the PStats index associated with this thread, or -1 if no index has yet been associated with this thread. This is used internally by the PStatClient; you should not need to call this directly.

Thread.get_python_index()

Returns the Python index associated with this thread, or -1 if no index has yet been associated with this thread. This is used internally by the direct.stdpy.thread module; you should not need to call this directly.

Thread.get_sync_name()

Returns the sync name of the thread. This name collects threads into “sync groups”, which are expected to run synchronously. This is mainly used for the benefit of PStats; threads with the same sync name can be ticked all at once via the thread_tick() call.

Thread.get_unique_id()

Returns a string that is guaranteed to be unique to this thread, across all processes on the machine, during at least the lifetime of this process.

Thread.is_joinable()

Returns the value of joinable that was passed to the start() call.

static Thread.is_simple_threads()

Returns true if Acron is currently compiled for “simple threads”, which is to say, cooperative context switching only, reducing the need for quite so many critical section protections. This is not necessarily the opposite of “true threads”, since one possible implementation of simple threads is via true threads with mutex protection to ensure only one runs at a time.

Thread.is_started()

Returns true if the thread has been started, false if it has not, or if join() has already been called.

static Thread.is_threading_supported()

Returns true if threading support has been compiled in and enabled, or false if no threading is available (and Thread::start() will always fail).

static Thread.is_true_threads()

Returns true if a real threading library is available that supports actual OS-implemented threads, or false if the only threading we can provide is simulated user-space threading.

Thread.join()

Blocks the calling process until the thread terminates. If the thread has already terminated, this returns immediately.

Thread.output()

Thread.output_blocker()

Writes a description of the mutex or condition variable that this thread is blocked on. Writes nothing if there is no blocker, or if we are not in DEBUG_THREADS mode.

Thread.preempt()

Indicates that this thread should run as soon as possible, preemptying any other threads that may be scheduled to run. This may not be implemented on every platform.

static Thread.prepare_for_exit()

Should be called by the main thread just before exiting the program, this blocks until any remaining thread cleanup has finished.

static Thread.relax()

Equivalent to the pause instruction on x86 or the yield instruction on ARM, to be called in spin loops.

Thread.set_min_pipeline_stage()

Sets this thread’s pipeline stage number to at least the indicated value, unless it is already larger. See set_pipeline_stage().

Thread.set_pipeline_stage()

Specifies the Pipeline stage number associated with this thread. The default stage is 0 if no stage is specified otherwise.

This must be a value in the range [0 .. pipeline->get_num_stages() - 1]. It specifies the values that this thread observes for all pipelined data. Typically, an application thread will leave this at 0, but a render thread may set it to 1 or 2 (to operate on the previous frame’s data, or the second previous frame’s data).

Thread.set_python_index()

Stores a Python index to be associated with this thread. This is used internally by the thread module; you should not need to call this directly.

static Thread.sleep()

Suspends the current thread for at least the indicated amount of time. It might be suspended for longer.

Thread.start()

Starts the thread executing. It is only valid to call this once.

The thread will begin executing its thread_main() function, and will terminate when thread_main() returns.

priority is intended as a hint to the relative importance of this thread. This may be ignored by the thread implementation.

joinable should be set true if you intend to call join() to wait for the thread to terminate, or false if you don’t care and you will never call join(). Note that the reference count on the Thread object is incremented while the thread itself is running, so if you just want to fire and forget a thread, you may pass joinable = false, and never store the Thread object. It will automatically destruct itself when it finishes.

The return value is true if the thread is successfully started, false otherwise.

static Thread.write_status()