Module org.praxislive.script
Package org.praxislive.script

Interface Env

public interface Env
Environment context interface passed in to StackFrame.process(org.praxislive.script.Env) and InlineCommand.process(org.praxislive.script.Env, org.praxislive.script.Namespace, java.util.List). An implementation of this interface provides access to various services of the script executor required to implement commands.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CONTEXT
    Name of the context variable that relative component, control and port addresses are resolved against.
    static final String
    PWD
    Name of the present working directory variable used to resolve relative file paths in various commands.

  • Method Summary

    Modifier and Type
    Method
    Description
    ControlAddress
    getAddress()
    The control address of this script executor.
    Lookup
    getLookup()
    Lookup object of the script executor.
    PacketRouter
    getPacketRouter()
    A packet router for sending calls during command execution.
    long
    getTime()
    Current clock time inside the script executor.

  • Field Details

    • CONTEXT

      static final String CONTEXT
      Name of the context variable that relative component, control and port addresses are resolved against. Used and controlled by the @ command.
      See Also:

    • PWD

      static final String PWD
      Name of the present working directory variable used to resolve relative file paths in various commands.
      See Also:

  • Method Details

    • getLookup

      Lookup getLookup()
      Lookup object of the script executor.
      Returns:
      lookup

    • getTime

      long getTime()
      Current clock time inside the script executor. Should be used when creating calls inside a command, and for any other purpose that the current clock time is required.
      Returns:
      current clock time
      See Also:

    • getPacketRouter

      PacketRouter getPacketRouter()
      A packet router for sending calls during command execution.
      Returns:
      packet router

    • getAddress

      ControlAddress getAddress()
      The control address of this script executor. Should be used as the from address in calls created during command execution. Replies to this address will be routed to StackFrame.postResponse(org.praxislive.core.Call) on the active command.
      Returns:
      script executor control address