net.sandius.rembulan.runtime

Class Coroutine

java.lang.Object

net.sandius.rembulan.runtime.Coroutine

public final class Coroutine
extends Object

A Lua coroutine.

This class does not expose any public API; to manipulate Coroutine objects, use the following methods in ExecutionContext:

• to create a new coroutine, use ExecutionContext.newCoroutine(LuaFunction);
• to get coroutine status, use ExecutionContext.getCoroutineStatus(Coroutine);
• to resume a coroutine, use ExecutionContext.resume(Coroutine, Object[]);
• to yield from a coroutine, use ExecutionContext.yield(Object[]).

Note on equality: according to §3.4.4 of the Lua Reference Manual, coroutines a and b are expected to be equal if and only if they are the same object. However, Ordering.isRawEqual(Object, Object) compares coroutines using Object.equals(Object). Exercise caution when overriding equals().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Coroutine.Status Coroutine status.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait