io.apigee.trireme.kernel

Interface GenericNodeRuntime

public interface GenericNodeRuntime

This is a high-level interface to the runtime of the script. It provides support for getting access to thread pools and other global information.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.Future<java.lang.Boolean>	createTimedTask(java.lang.Runnable r, long delay, java.util.concurrent.TimeUnit unit, boolean repeating, java.lang.Object domain) Execute a ask after "delay".
void	executeScriptTask(java.lang.Runnable task, java.lang.Object domain) Execute a task in the script thread, and set the domain on the thread before doing so.
java.util.concurrent.ExecutorService	getAsyncPool() Return the thread pool that may be used to run short-lived asynchronous tasks.
java.lang.Object	getDomain() Return the current Node.js domain of the calling scrpit.
NetworkPolicy	getNetworkPolicy() Return an object that must be called every time the process tries to open an outgoing network connection or listen for incoming connections.
java.nio.channels.Selector	getSelector() Get the network selector -- internal only.
java.util.concurrent.ExecutorService	getUnboundedPool() Return the thread pool that may be used to run tasks that should start immediately in a new thread regardless of the thread pool size.
void	pin() Increment the "pin count" on this script.
void	registerCloseable(java.io.Closeable c) Put an object on a list of handles that will be automatically closed when the script exits.
void	unPin() Decrement the "pin count," which may cause the script to exit at the end of the current function.
void	unregisterCloseable(java.io.Closeable c) Remove the object from the list of handles that will be closed.

Method Detail

pin

void pin()

Increment the "pin count" on this script. A script with a pin count of zero will remain running and in an idle state until there is work to do. Once the pin count again reaches zero the script may exit.

unPin

void unPin()

Decrement the "pin count," which may cause the script to exit at the end of the current function.

getAsyncPool

java.util.concurrent.ExecutorService getAsyncPool()

Return the thread pool that may be used to run short-lived asynchronous tasks. Tasks submitted to this pool may queue.

getUnboundedPool

java.util.concurrent.ExecutorService getUnboundedPool()

Return the thread pool that may be used to run tasks that should start immediately in a new thread regardless of the thread pool size. This thread pool should be used sparingly to start long-lived threads, for instance to read an I/O stream with a synchronous interface.

registerCloseable

void registerCloseable(java.io.Closeable c)

Put an object on a list of handles that will be automatically closed when the script exits. This prevents resource leaks in multi-tenant script environments. Like many other things this method is not thread-safe and must be called from inside the main script thread.

unregisterCloseable

void unregisterCloseable(java.io.Closeable c)

Remove the object from the list of handles that will be closed.

getSelector

java.nio.channels.Selector getSelector()

Get the network selector -- internal only.

getNetworkPolicy

NetworkPolicy getNetworkPolicy()

Return an object that must be called every time the process tries to open an outgoing network connection or listen for incoming connections. This may be used to protect access to and from certain hosts on an internal network.

getDomain

java.lang.Object getDomain()

Return the current Node.js domain of the calling scrpit. This should be replaced when executing asynchronous tasks.

executeScriptTask

void executeScriptTask(java.lang.Runnable task,
                       java.lang.Object domain)

Execute a task in the script thread, and set the domain on the thread before doing so. This method may be called from any thread.

createTimedTask

java.util.concurrent.Future<java.lang.Boolean> createTimedTask(java.lang.Runnable r,
                                                               long delay,
                                                               java.util.concurrent.TimeUnit unit,
                                                               boolean repeating,
                                                               java.lang.Object domain)

Execute a ask after "delay". This method may be called from any thread. It returns a Future which may be used to cancel the task, but it will always return "null" as a result.