IPythonThreading#

Fully qualified name: carb::scripting::IPythonThreading

Defined in carb/scripting/IPythonThreading.h

class IPythonThreading#

Allows limited control over Python threading aspects without causing Python to be loaded in the process or requiring direct knowledge of Python.

If Python is loaded into the project, this interface must be told by calling IPythonThreading::checkLoaded(). Carbonite will automatically call this function when carb.scripting-python.plugin is started, or when a Python binding is loaded into Python, and when the Framework is started. If Python is loaded into the process through different means, this function must be called.

See also

AcquirePythonGil ReleasePythonGil

Note

This interface is built-in to the Carbonite Framework, so it should be available as long as the Framework has been started.

Public Functions

virtual PythonThreadingState checkLoaded() = 0#

Checks whether Python is loaded into the process and returns the state value.

Typically this function does not need to be manually called as it is automatically called by the Framework when Python bindings (or an owner, like carb.scripting-python.plugin) are loaded. It would need to be called if Python was loaded through other means and use of AcquirePythonGil and ReleasePythonGil was desired.

Note

This function can be expensive to call since modules loaded into the process are enumerated and Python calls can be made.

Returns:

A PythonThreadingState value indicating the status of python.

virtual bool ownsGil() const = 0#

Checks whether the calling thread currently owns the Global Interpreter Lock (GIL).

Note

If checkLoaded() returns anything other than PythonThreadingState::eInitialized, this function will return false.

Returns:

true if the calling thread owns the GIL; false otherwise.

Public Static Functions

static inline constexpr carb::InterfaceDesc getInterfaceDesc(

) noexcept#

Returns information about this interface.

Auto-generated by CARB_PLUGIN_INTERFACE() or CARB_PLUGIN_INTERFACE_EX.

Returns:

The carb::InterfaceDesc struct with information about this interface.

static inline constexpr carb::InterfaceDesc getLatestInterfaceDesc(

) noexcept#

Returns information about the latest version of this interface.

Auto-generated by CARB_PLUGIN_INTERFACE() or CARB_PLUGIN_INTERFACE_EX.

Returns:

The carb::InterfaceDesc struct with information about the latest version of this interface.