net.sandius.rembulan.exec

Class DirectCallExecutor

java.lang.Object

net.sandius.rembulan.exec.DirectCallExecutor

public class DirectCallExecutor
extends Object

A call executor that executes Lua calls and asynchronous tasks scheduled by these calls in the current thread. The executor uses a SchedulingContextFactory to instantiate scheduling contexts.

Method Summary

Modifier and Type	Method and Description
Object[]	call(StateContext stateContext, Object fn, Object... args) Calls fn(args...) in the current thread in the state context stateContext, returning the call result once the call completes.
static Object[]	execute(Continuation continuation) Executes continuation in the current thread in a scheduling context that never asks the execution to pause, returning the call result once the call completes.
static Object[]	execute(Continuation continuation, SchedulingContext schedulingContext) Resumes continuation in the current thread in the scheduling context schedulingContext, returning the call result once the call completes.
static Object[]	execute(Continuation continuation, SchedulingContext schedulingContext, boolean convertResultsToJava) Resumes continuation in the current thread in the scheduling context schedulingContext, returning the call result once the call completes.
static DirectCallExecutor	newExecutor() Returns a new direct call executor with a scheduler that never requests executions to be paused.
static DirectCallExecutor	newExecutor(SchedulingContextFactory schedulingContextFactory) Returns a new direct call executor with the specified scheduling context factory used to instantiate a new scheduling context on each resume.
static DirectCallExecutor	newExecutorWithTickLimit(long ticksLimit) Returns a new direct call executor that uses that asks each continuation it resumes to pause after it has registered ticksLimit ticks.
Object[]	resume(Continuation continuation) Resumes continuation in the current thread, returning the call result once the call completes.
SchedulingContextFactory	schedulingContextFactory() Returns the scheduling context factory used by this executor.

Methods inherited from class java.lang.Object

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

Method Detail

newExecutor

public static DirectCallExecutor newExecutor()

Returns a new direct call executor with a scheduler that never requests executions to be paused.

Returns:

a direct call executor that never asks continuations to be paused

newExecutor

public static DirectCallExecutor newExecutor(SchedulingContextFactory schedulingContextFactory)

Returns a new direct call executor with the specified scheduling context factory used to instantiate a new scheduling context on each resume.

Parameters:

schedulingContextFactory - the scheduling context factory, must not be null

Returns:

a direct call executor that uses the specified scheduling context factory

Throws:

NullPointerException - if schedulingContextFactory is null

newExecutorWithTickLimit

public static DirectCallExecutor newExecutorWithTickLimit(long ticksLimit)

Returns a new direct call executor that uses that asks each continuation it resumes to pause after it has registered ticksLimit ticks.

Parameters:

ticksLimit - the tick limit for resumes, must be positive

Returns:

a direct call executor that caps resumes at the given tick limit

Throws:

IllegalArgumentException - if ticksLimit is not positive

schedulingContextFactory

public SchedulingContextFactory schedulingContextFactory()

Returns the scheduling context factory used by this executor.

Returns:

the scheduling context factory used by this executor

call

public Object[] call(StateContext stateContext,
                     Object fn,
                     Object... args)
              throws CallException,
                     CallPausedException,
                     InterruptedException

Calls fn(args...) in the current thread in the state context stateContext, returning the call result once the call completes.

The call result will be passed in a freshly-allocated array, and may therefore be manipulated freely by the caller of this method.

Parameters:

stateContext - state context of the call, must not be null

fn - the call target, may be null

args - call arguments, must not be null

Returns:

the call result

Throws:

CallException - if the call terminated abnormally

CallPausedException - if the call initiated a pause

InterruptedException - when the current thread is interrupted while waiting for an asynchronous operation to be completed

NullPointerException - if stateContext or args is null

resume

public Object[] resume(Continuation continuation)
                throws CallException,
                       CallPausedException,
                       InterruptedException

Resumes continuation in the current thread, returning the call result once the call completes.

The call result will be passed in a freshly-allocated array, and may therefore be manipulated freely by the caller of this method.

Parameters:

continuation - the continuation to resume, must not be null

Returns:

the call result

Throws:

CallException - if the call terminated abnormally

CallPausedException - if the call initiated a pause

InterruptedException - when the current thread is interrupted while waiting for an asynchronous operation to be completed

InvalidContinuationException - when continuation is invalid

NullPointerException - if continuation is null

execute

public static Object[] execute(Continuation continuation,
                               SchedulingContext schedulingContext,
                               boolean convertResultsToJava)
                        throws CallException,
                               CallPausedException,
                               InterruptedException

Resumes continuation in the current thread in the scheduling context schedulingContext, returning the call result once the call completes.

The call result will be passed in a freshly-allocated array, and may therefore be manipulated freely by the caller of this method. If convertResultsToJava is true, the result values will be converted to Java using Conversions.toJavaValues(Object[]).

Parameters:

continuation - the continuation to resume, must not be null

schedulingContext - the scheduling context, must not be null

convertResultsToJava - flag controlling the conversion of result values to their Java representations

Returns:

the call result, converted to Java representations if convertResults is true

Throws:

CallException - if the call terminated abnormally

CallPausedException - if the call initiated a pause

InterruptedException - when the current thread is interrupted while waiting for an asynchronous operation to be completed

InvalidContinuationException - when continuation is invalid

NullPointerException - if continuation or schedulingContext is null

execute

public static Object[] execute(Continuation continuation,
                               SchedulingContext schedulingContext)
                        throws CallException,
                               CallPausedException,
                               InterruptedException

Resumes continuation in the current thread in the scheduling context schedulingContext, returning the call result once the call completes.

The call result will be passed in a freshly-allocated array, and may therefore be manipulated freely by the caller of this method.

This method converts return values to Java values using Conversions.toJavaValues(Object[]). For a greater control over this behaviour, use execute(Continuation, SchedulingContext, boolean) instead.

Parameters:

continuation - the continuation to resume, must not be null

schedulingContext - the scheduling context, must not be null

Returns:

the call result

Throws:

CallException - if the call terminated abnormally

CallPausedException - if the call initiated a pause

InterruptedException - when the current thread is interrupted while waiting for an asynchronous operation to be completed

InvalidContinuationException - when continuation is invalid

NullPointerException - if continuation or schedulingContext is null

execute

public static Object[] execute(Continuation continuation)
                        throws CallException,
                               CallPausedException,
                               InterruptedException

Executes continuation in the current thread in a scheduling context that never asks the execution to pause, returning the call result once the call completes.

The call result will be passed in a freshly-allocated array, and may therefore be manipulated freely by the caller of this method.

This method converts return values to Java values using Conversions.toJavaValues(Object[]). For a greater control over this behaviour, use execute(Continuation, SchedulingContext, boolean) instead.

Parameters:

continuation - the continuation to resume, must not be null

Returns:

the call result

Throws:

CallException - if the call terminated abnormally

CallPausedException - if the call initiated a pause

InterruptedException - when the current thread is interrupted while waiting for an asynchronous operation to be completed

InvalidContinuationException - when continuation is invalid

NullPointerException - if continuation or schedulingContext is null