coroutine.status
Lua function

coroutine.status

Summary

Returns the status of a thread

Prototype

s = coroutine.status (thread)


Description

Returns a string indicating the status of the thread. Raises an error if the argument is not a thread.

If it is, the values returned can be:


  • running
  • normal
  • suspended
  • dead


A thread is "running" if coroutine.status is called from within the thread itself.

A thread is "normal" if the coroutine is active, but has resumed another coroutine.

It is "suspended" after being created but before it is resumed, and after yielding.

It is "dead" after it has returned from the entire function.



print (coroutine.status (thread)) --> suspended


See Also ...

Topics

DOC_lua_base Lua base functions
DOC_lua_bc Lua bc (big number) functions
DOC_lua_bit Lua bit manipulation functions
DOC_lua_coroutines Lua coroutine functions
DOC_lua_debug Lua debug functions
DOC_lua_io Lua io functions
DOC_lua_math Lua math functions
DOC_lua_os Lua os functions
DOC_lua_package Lua package functions
DOC_lua_rex Lua PCRE regular expression functions
DOC_lua Lua script extensions
DOC_lua_string Lua string functions
DOC_lua_tables Lua table functions
DOC_lua_utils Lua utilities
DOC_scripting Scripting

Lua functions

LUA_coroutine.create coroutine.create (Creates a new coroutine thread)
LUA_coroutine.resume coroutine.resume (Start or resume a thread)
LUA_coroutine.running coroutine.running (Returns the running coroutine)
LUA_coroutine.wrap coroutine.wrap (Creates a thread and returns a function to resume it)
LUA_coroutine.yield coroutine.yield (Yields execution of thread back to the caller)

(Help topic: lua=coroutine.status)

DOC_contents Documentation contents page