sol2/docs/source/api/thread.rst

thread
======
a separate state that can contain and run functions
---------------------------------------------------

.. code-block:: cpp
	
	class thread : public reference { /* ... */ };

``sol::thread`` is a separate runnable part of the Lua VM that can be used to execute work separately from the main thread, such as with :doc:`coroutines<coroutine>`. To take a table or a coroutine and run it specifically on the ``sol::thread`` you either pulled out of lua or created, just get that function through the :ref:`state of the thread<thread_state>`

.. note::

	A CPU thread is not always equivalent to a new thread in Lua: ``std::this_thread::get_id()`` can be the same for 2 callbacks that have 2 distinct Lua threads. In order to know which thread a callback was called in, hook into :doc:`sol::this_state<this_state>` from your Lua callback and then construct a ``sol::thread``, passing in the ``sol::this_state`` for both the first and last arguments. Then examine the results of the status and ``is_...`` calls below.

members
-------

.. code-block:: cpp
	:caption: constructor: thread

	thread(stack_reference r);
	thread(lua_State* L, int index = -1);
	thread(lua_State* L, lua_State* actual_thread);

Takes a thread from the Lua stack at the specified index and allows a person to use all of the abstractions therein. It can also take an actual thread state to make a thread from that as well.

.. code-block:: cpp
	:caption: function: view into thread_state()'s state

	state_view state() const;

This retrieves the current state of the thread, producing a :doc:`state_view<state>` that can be manipulated like any other. :doc:`Coroutines<coroutine>` pulled from Lua using the thread's state will be run on that thread specifically.

.. _thread_state:

.. code-block:: cpp
	:caption: function: retrieve thread state object

	lua_State* thread_state () const;

This function retrieves the ``lua_State*`` that represents the thread.

.. code-block:: cpp
	:caption: current thread status

	thread_status status () const;

Retrieves the :doc:`thread status<types>` that describes the current state of the thread.

.. code-block:: cpp
	:caption: main thread status

	bool is_main_thread () const;

Checks to see if the thread is the main Lua thread.

.. code-block:: cpp
	:caption: function: thread creation
	:name: thread-create

	thread create();
	static thread create (lua_State* L);

Creates a new thread from the given a ``lua_State*``.