Package info.mikethomas.jfold

Interface Connection

All Known Implementing Classes:
ClientConnection
public interface Connection

Connection interface.

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

  • Method Details

    • bond

      void bond(Inet4Address ip, int port, String input)
      Bond a packet file to a outgoing debug socket connection.
      Parameters:
      ip - a Inet4Address object.
      port - a int.
      input - a String object.

    • configured

      void configured()
      Return a configuration indicating if the client has set a user, team or passkey.

    • doCycle

      void doCycle()
      Run one client cycle.

    • downloadCore

      void downloadCore(String type, URL url)
      Download a core.
      Parameters:
      type - of core
      url - of core

    • finish

      void finish()
      Finish all slots.

    • finish

      void finish(int slot)
      Finish requested slot.
      Parameters:
      slot - number

    • getInfo

      String getInfo(String category, String key) throws InfoException
      Print application information for requested category and key.
      Parameters:
      category - to return information from
      key - to return information from
      Returns:
      String value from information
      Throws:
      InfoException - if any.

    • getInfo

      String getInfo(InfoItem infoItem) throws InfoException
      Print application information for requested InfoItem.
      Parameters:
      infoItem - a InfoItem object.
      Returns:
      a String object.
      Throws:
      InfoException - if any.

    • info

      List info() throws InfoException
      List application information.
      Returns:
      List
      Throws:
      InfoException - if any.

    • inject

      void inject(Inet4Address ip, int port, String input)
      Inject a packet file to a listening debug socket. Will wait until packet is processed.
      Parameters:
      ip - a Inet4Address object.
      port - a int.
      input - a String object.

    • maskUnitState

      void maskUnitState()
      Disable specified unit states.

    • numSlots

      int numSlots() throws NumSlotsException
      Get number of slots.
      Returns:
      integer number of slots
      Throws:
      NumSlotsException - if any.

    • option

      String option(String name)
      Get a configuration option.
      Parameters:
      name - of option
      Returns:
      requested option

    • option

      String option(String name, String value)
      Set a configuration option.
      Parameters:
      name - of option
      value - to set
      Returns:
      requested option

    • options

      Options options() throws OptionsException
      List all options with their non-default values.
      Returns:
      Options
      Throws:
      OptionsException - if any.

    • options

      Options options(boolean listDefault, boolean listUnset) throws OptionsException
      List all options with their non-default values.
      Parameters:
      listDefault - if true defaulted options will be listed
      listUnset - if true unset options will also be listed
      Returns:
      Options
      Throws:
      OptionsException - if any.

    • pause

      void pause()
      Pause all slots.

    • pause

      void pause(int slot)
      Pause requested slot.
      Parameters:
      slot - number

    • ppd

      int ppd() throws PpdException
      Get current total estimated Points Per Day.
      Returns:
      points per day
      Throws:
      PpdException - if any.

    • queueInfo

      List<Unit> queueInfo() throws QueueInfoException
      Get work unit queue information.
      Returns:
      List Unit
      Throws:
      QueueInfoException - if any.

    • requestId

      void requestId()
      Request an ID from the assignment server.

    • requestWs

      void requestWs()
      Request work server assignment from the assignment server.

    • save

      void save()
      Save the configuration either to the file the configuration was last loaded from.

    • save

      void save(String file)
      Save the configuration either to the specified file.
      Parameters:
      file - to save to

    • shutdown

      void shutdown()
      Shutdown the application.

    • simulationInfo

      SimulationInfo simulationInfo(int slot) throws SimulationInfoException
      Get current simulation information.
      Parameters:
      slot - number
      Returns:
      SimulationInfo
      Throws:
      SimulationInfoException - if any.

    • slotAdd

      void slotAdd(String type)
      Add a new slot.
      Parameters:
      type - of slot

    • slotDelete

      void slotDelete(int slot)
      Delete a slot. If it is running a unit it will be stopped.
      Parameters:
      slot - number

    • slotInfo

      List<Slot> slotInfo() throws SlotInfoException
      Get slot information.
      Returns:
      List Slot
      Throws:
      SlotInfoException - if any.

    • slotModify

      void slotModify(String id, String type)
      Modify an existing slot.
      Parameters:
      id - string
      type - string

    • slotOptions

      SlotOptions slotOptions(int slot) throws SlotOptionsException
      Get slot options.
      Parameters:
      slot - a int.
      Returns:
      SlotOptions options
      Throws:
      SlotOptionsException - if any.

    • trajectory

      void trajectory(int slot)
      Get current protein trajectory.
      Parameters:
      slot - number

    • triggerSave

      void triggerSave()
      Trigger config save after a delay.

    • unpause

      void unpause()
      Unpause all slots.

    • unpause

      void unpause(int slot)
      Unpause requested slot.
      Parameters:
      slot - number

    • uptime

      String uptime()
      Print application uptime.
      Returns:
      uptime value in "HH\h MM\m SS\s" format

    • waitForUnits

      void waitForUnits()
      Wait for all running units to finish.