io.apigee.trireme.core

Interface NodeRuntime

All Superinterfaces:

GenericNodeRuntime

All Known Implementing Classes:

ScriptRunner

public interface NodeRuntime
extends GenericNodeRuntime

This interface is passed to internal Node modules. It allows them to interface with the runtime, including submitting tasks that may run in the event loop.

Method Summary

Methods

Modifier and Type	Method and Description
void	enqueueCallback(org.mozilla.javascript.Function f, org.mozilla.javascript.Scriptable scope, org.mozilla.javascript.Scriptable thisObj, Object[] args) Put a task on the tick queue to run the specified function in the specified scope.
void	enqueueCallback(org.mozilla.javascript.Function f, org.mozilla.javascript.Scriptable scope, org.mozilla.javascript.Scriptable thisObj, Object domain, Object[] args) Put a task on the tick queue to run the specified function in the specified scope.
void	enqueueTask(ScriptTask task) Put a task on the tick queue to be run in the main script thread.
void	enqueueTask(ScriptTask task, Object domain) Put a task on the tick queue to be run in the main script thread.
NodeEnvironment	getEnvironment() Return the Environment used to create this script.
Sandbox	getSandbox() Return the sandbox used to limit script execution, or null if none was set
NodeScript	getScriptObject() Return the "NodeScript" used to create this script.
Object	require(String modName, org.mozilla.javascript.Context cx) Just like "require" in the regular "module" code, it returns the export object for the named module.
String	reverseTranslatePath(String path) Given a file path, return what the path would be within the Node environment.
File	translatePath(String path) Given a file path, return a File object that represents the actual file to open.

Methods inherited from interface io.apigee.trireme.kernel.GenericNodeRuntime

createTimedTask, executeScriptTask, getAsyncPool, getDomain, getNetworkPolicy, getSelector, getUnboundedPool, pin, registerCloseable, unPin, unregisterCloseable

Method Detail

getEnvironment

NodeEnvironment getEnvironment()

Return the Environment used to create this script.

getScriptObject

NodeScript getScriptObject()

Return the "NodeScript" used to create this script.

getSandbox

Sandbox getSandbox()

Return the sandbox used to limit script execution, or null if none was set

require

Object require(String modName,
             org.mozilla.javascript.Context cx)

Just like "require" in the regular "module" code, it returns the export object for the named module. May be used when one native module depends on another.

enqueueTask

void enqueueTask(ScriptTask task)

Put a task on the tick queue to be run in the main script thread. This method may be called from any thread and will cause the script to be run in the main script thread. This method is the only way that code running outside the main script thread should cause work to be done in the main thread.

enqueueTask

void enqueueTask(ScriptTask task,
               Object domain)

Put a task on the tick queue to be run in the main script thread. This method may be called from any thread and will cause the script to be run in the main script thread. This method is the only way that code running outside the main script thread should cause work to be done in the main thread.

enqueueCallback

void enqueueCallback(org.mozilla.javascript.Function f,
                   org.mozilla.javascript.Scriptable scope,
                   org.mozilla.javascript.Scriptable thisObj,
                   Object[] args)

Put a task on the tick queue to run the specified function in the specified scope. This is a convenience method that simplifies tasks submitted using the "enqueueTask" method.

Parameters:

f - Function to call

scope - the scope where the function should run

thisObj - the value of "this" where the function should run, or null

args - arguments for the function, or null

enqueueCallback

void enqueueCallback(org.mozilla.javascript.Function f,
                   org.mozilla.javascript.Scriptable scope,
                   org.mozilla.javascript.Scriptable thisObj,
                   Object domain,
                   Object[] args)

Put a task on the tick queue to run the specified function in the specified scope. This is a convenience method that simplifies tasks submitted using the "enqueueTask" method.

Parameters:

f - Function to call

scope - the scope where the function should run

thisObj - the value of "this" where the function should run, or null

domain - the domain where this callback should run -- should set to the current domain

args - arguments for the function, or null

translatePath

File translatePath(String path)

Given a file path, return a File object that represents the actual file to open. If a PathTranslator was registered with the current script, it will use to re-map the file to the translated path. If the path cannot be resolved within the current environment, null be returned, meaning that the file cannot be opened in the current environment.

reverseTranslatePath

String reverseTranslatePath(String path)
                            throws IOException

Given a file path, return what the path would be within the Node environment. This is used to convert native path names to path names that will work within the script. This uses the PathTranslator, if set. In other words, this is supposed to be the inverse of "translatePath."

Throws:

IOException