• View
• Edit
• History
• Print

Index

Accessor Functions

The following functions should be invoked as a.f(), where a is the accessor and f is the function name. To invoke from within one of the accessor functions like an input handler, use this.f().

• addInputHandler: Add a function to handle new inputs.
• connect: Connect one or two contained accessors (see Accessor Specification#Composition).
• extend: Declare that the accessor extends another accessor.
• get: Retrieve the value of an input.
• getParameter: Retrieve the value of a parameter.
• input: Specify an input to the accessor.
• implement: Declare that the accessor implements another interface.
• instantiate: Instantiate a contained accessor (see Accessor Specification#Composition).
• output: Specify an output from the accessor.
• parameter: Specify a parameter for the accessor.
• removeInputHandler: Remove an input handler.
• send: Send an output or to the accessor's own input
• setDefault: Set the default value of an input.
• setParameter: Set the value of a parameter.
• stop: Request that the enclosing swarmlet stop execution.

Functions Exported by an Accessor

The following functions are invoked by the host on the accessor (so that this will be the accessor, and this.f() can be used to invoke any of the above functions with name f).

• fire: Fire the accessor.
• initialize: Initialize the accessor.
• latestOutput: Return the most recent output sent via the named output.
• provideInput: Provide to a named input the given value.
• react: React to any inputs that have been provided.
• setParameter: Set a parameter with the given name to the given value.
• setup: Set up the actor interface.
• wrapup: Wrap up execution of the accessor.

Top-Level Functions

The following function can be invoked in any context by the accessor simply as f(), where f is the function name.

• clearInterval: Cancel a function being invoked periodically.
• clearTimeout: Cancel a function pending invocation after a delay.
• currentTime: Return the current time as understood by the host.
• error: Signal an error.
• getResource: Get a resource from the swarmlet host.
• require: Specify a module required by the accessor.
• setInterval: Specify a function to be invoked periodically.
• setTimeout: Specify a function to be invoked after a delay.