Package info.mikethomas.jfold.util

Enum Class Command

java.lang.Object
java.lang.Enum<Command>
info.mikethomas.jfold.util.Command
All Implemented Interfaces:
Serializable, Comparable<Command>, Constable
public enum Command extends Enum<Command>

Command class.

Version:
7.6.21
Author:
Michael Thomas (mikepthomas@outlook.com)

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADD
    Add two values.
    AUTH
    Authenticate.
    BOND
    Bond a packet file to a outgoing debug socket connection.
    CLEAR
    Clear the screen.
    CONFIGURED
    Return a PyON message indicating if the client has set a user, team or passkey.
    DATE
    Print the date and time.
    DIV
    Divide two values.
    DO_CYCLE
    Run one client cycle.
    DOWNLOAD_CORE
    Deprecated.
    Command no longer supported.
    ERROR
    Error message.
    EVAL
    Evaluate all arguments.
    EXIT
    Exit the command processor.
    FINISH
    Finish all or one slot(s).
    GET_INFO
    Print application information.
    HEARTBEAT
    Prints an increasing heartbeat count.
    IF
    If 'cond' evaluates to a non-empty string then evalute 'expr1' otherwise, if provided, evaluate 'expr2'.
    INFO
    Print application information in PyON format.
    INJECT
    Inject a packet file to a listening debug socket.
    LOG_UPDATES
    Enable/disable log updates.
    MASK_UNIT_STATE
    Disable specified unit states.
    MUL
    Multiply two values.
    NOT
    Invert the truth value of the argument.
    NUM_SLOTS
    Get number of slots in PyON format.
    OPTION
    Get or set a configuration option.
    OPTIONS
    List or set options with their values.
    PAUSE
    Pause all or one slot(s).
    PPD
    Get current total estimated Points Per Day.
    QUEUE_INFO
    Get work unit queue information in PyON format.
    QUIT
    Exit the command processor.
    REQUEST_ID
    Request an ID from the assignment server.
    REQUEST_WS
    Request work server assignment from the assignment server.
    SAVE
    Save the configuration either to the specified file or to the file the configuration was last loaded from.
    SCREENSAVER
    Unpause all slots which are paused waiting for a screensaver and pause them again on disconnect.
    SHUTDOWN
    Shutdown the application.
    SIMULATION_INFO
    Get current simulation information.
    SLEEP
    Sleep for a number of seconds.
    SLOT_ADD
    Add a new slot.
    SLOT_DELETE
    Delete a slot.
    SLOT_INFO
    Get slot information in PyON format.
    SLOT_MODIFY
    Modify an existing slot.
    SLOT_OPTIONS
    The first argument is the slot ID.
    SUB
    Subtract two values.
    TRAJECTORY
    Get current protein trajectory.
    TRIGGER_SAVE
    Trigger config save after a delay.
    UNPAUSE
    Unpause all or one slot(s).
    UPDATES
    Enable/disable updates.
    UPTIME
    Print application uptime.
    WAIT_FOR_UNITS
    Wait for all running units to finish.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCommand()
    Command.
    ResponseType
    getResponseType()
    Response type of this command.
    String
    toString()
    static Command
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Command[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • AUTH

      public static final Command AUTH
      Authenticate.

    • ERROR

      public static final Command ERROR
      Error message.

    • EXIT

      public static final Command EXIT
      Exit the command processor.

    • HEARTBEAT

      public static final Command HEARTBEAT
      Prints an increasing heartbeat count.

    • LOG_UPDATES

      public static final Command LOG_UPDATES
      Enable/disable log updates.

    • QUIT

      public static final Command QUIT
      Exit the command processor.

    • SCREENSAVER

      public static final Command SCREENSAVER
      Unpause all slots which are paused waiting for a screensaver and pause them again on disconnect.

    • UPDATES

      public static final Command UPDATES
      Enable/disable updates.

    • BOND

      public static final Command BOND
      Bond a packet file to a outgoing debug socket connection.

    • CONFIGURED

      public static final Command CONFIGURED
      Return a PyON message indicating if the client has set a user, team or passkey.

    • DO_CYCLE

      public static final Command DO_CYCLE
      Run one client cycle.

    • DOWNLOAD_CORE

      @Deprecated public static final Command DOWNLOAD_CORE
      Deprecated.
      Command no longer supported.
      Download a core.

    • FINISH

      public static final Command FINISH
      Finish all or one slot(s).

    • GET_INFO

      public static final Command GET_INFO
      Print application information.

    • INFO

      public static final Command INFO
      Print application information in PyON format.

    • INJECT

      public static final Command INJECT
      Inject a packet file to a listening debug socket. Will wait until packet is processed.

    • MASK_UNIT_STATE

      public static final Command MASK_UNIT_STATE
      Disable specified unit states.

    • NUM_SLOTS

      public static final Command NUM_SLOTS
      Get number of slots in PyON format.

    • OPTION

      public static final Command OPTION
      Get or set a configuration option.

    • OPTIONS

      public static final Command OPTIONS
      List or set options with their values. If no name arguments are given then all options with non-default values will be listed. If the '-d' argument is given then even defaulted options will be listed. If the '-a' option is given then unset options will also be listed. Otherwise, if option names are provided only those options will be listed. The special name '*' lists all options which have not yet been listed and is affected by the '-d' and '-a' options. If a name argument is followed directly by an equal sign then the rest of the argument will be used to set the option's value. If instead a name argument is followed immediately by a '!' then the option will be reset to its default value. Options which are set or reset will also be listed. Options are listed as a PyON format dictionary.

    • PAUSE

      public static final Command PAUSE
      Pause all or one slot(s).

    • PPD

      public static final Command PPD
      Get current total estimated Points Per Day.

    • QUEUE_INFO

      public static final Command QUEUE_INFO
      Get work unit queue information in PyON format.

    • REQUEST_ID

      public static final Command REQUEST_ID
      Request an ID from the assignment server.

    • REQUEST_WS

      public static final Command REQUEST_WS
      Request work server assignment from the assignment server.

    • SAVE

      public static final Command SAVE
      Save the configuration either to the specified file or to the file the configuration was last loaded from.

    • SHUTDOWN

      public static final Command SHUTDOWN
      Shutdown the application.

    • SIMULATION_INFO

      public static final Command SIMULATION_INFO
      Get current simulation information.

    • SLOT_ADD

      public static final Command SLOT_ADD
      Add a new slot. Configuration options for the new slot can be provided.

    • SLOT_DELETE

      public static final Command SLOT_DELETE
      Delete a slot. If it is running a unit it will be stopped.

    • SLOT_INFO

      public static final Command SLOT_INFO
      Get slot information in PyON format.

    • SLOT_MODIFY

      public static final Command SLOT_MODIFY
      Modify an existing slot. Configuration options can be either set or reset using the same syntax used by the 'options' command.

    • SLOT_OPTIONS

      public static final Command SLOT_OPTIONS
      The first argument is the slot ID. See 'options' help for a description of the remaining arguments.

    • TRAJECTORY

      public static final Command TRAJECTORY
      Get current protein trajectory.

    • TRIGGER_SAVE

      public static final Command TRIGGER_SAVE
      Trigger config save after a delay.

    • UNPAUSE

      public static final Command UNPAUSE
      Unpause all or one slot(s).

    • UPTIME

      public static final Command UPTIME
      Print application uptime.

    • WAIT_FOR_UNITS

      public static final Command WAIT_FOR_UNITS
      Wait for all running units to finish.

    • ADD

      public static final Command ADD
      Add two values.

    • CLEAR

      public static final Command CLEAR
      Clear the screen.

    • DATE

      public static final Command DATE
      Print the date and time. Optionally, with 'format'. See: man strftime

    • DIV

      public static final Command DIV
      Divide two values.

    • EVAL

      public static final Command EVAL
      Evaluate all arguments.

    • IF

      public static final Command IF
      If 'cond' evaluates to a non-empty string then evalute 'expr1' otherwise, if provided, evaluate 'expr2'.

    • MUL

      public static final Command MUL
      Multiply two values.

    • NOT

      public static final Command NOT
      Invert the truth value of the argument.

    • SLEEP

      public static final Command SLEEP
      Sleep for a number of seconds.

    • SUB

      public static final Command SUB
      Subtract two values.

  • Method Details

    • values

      public static Command[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Command valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<Command>

    • getCommand

      public String getCommand()
      Command.
      Returns:
      String Folding@Home command.

    • getResponseType

      public ResponseType getResponseType()
      Response type of this command.
      Returns:
      ResponseType type of response.