Package org.harctoolbox.harchardware.comm

Class UrlPort

java.lang.Object
org.harctoolbox.harchardware.comm.UrlPort
All Implemented Interfaces:
Closeable, AutoCloseable, ICommandLineDevice, IHarcHardware
public class UrlPort extends Object implements ICommandLineDevice

  • Constructor Details

    • UrlPort

      public UrlPort(String protocol, String hostIp, int portNumber, String prefix, String suffix, int timeout, boolean verbose)

  • Method Details

    • main

      public static void main(String[] args)
      Parameters:
      args - the command line arguments

    • connect

      public void connect() throws IOException
      Throws:
      IOException

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable

    • sendString

      public void sendString(String payload) throws IOException
      Description copied from interface: ICommandLineDevice
      Sends a command (a String) to the instance.
      Specified by:
      sendString in interface ICommandLineDevice
      Parameters:
      payload - Command string to be sent.
      Throws:
      IOException

    • readString

      public String readString()
      Description copied from interface: ICommandLineDevice
      Reads a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed.
      Specified by:
      readString in interface ICommandLineDevice
      Returns:
      A String containing the contents of the line, not including any line-termination characters, or null if no input available.

    • readString

      public String readString(boolean wait)
      Description copied from interface: ICommandLineDevice
      Reads a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed.
      Specified by:
      readString in interface ICommandLineDevice
      Parameters:
      wait - if true, wait until something arrives, otherwise return null if nothing there.
      Returns:
      A String containing the contents of the line, not including any line-termination characters, or null if no input available.

    • getVersion

      public String getVersion() throws IOException
      Description copied from interface: IHarcHardware
      Returns the hardware version (not the version of the driver software). May be null if no relevant information available.
      Specified by:
      getVersion in interface IHarcHardware
      Returns:
      Version string. Semantics can vary.
      Throws:
      IOException

    • setVerbose

      public void setVerbose(boolean verbose)
      Description copied from interface: IHarcHardware
      Sets a verbosity flag, causing commands to be executed verbosely. Exact semantic depends on the implementation. Typically, all communication with the device is echoed to stderr.
      Specified by:
      setVerbose in interface IHarcHardware
      Parameters:
      verbose - on or off

    • setDebug

      public void setDebug(int debug)
      Description copied from interface: IHarcHardware
      Sets a debug parameter. Exact semantic depends on the implementation.
      Specified by:
      setDebug in interface IHarcHardware

    • setTimeout

      public void setTimeout(int timeout)
      Description copied from interface: IHarcHardware
      Set timeout in milliseconds. Exact semantics may be dependent on the hardware.
      Specified by:
      setTimeout in interface IHarcHardware
      Parameters:
      timeout - Timeout in milliseconds.

    • isValid

      public boolean isValid()
      Description copied from interface: IHarcHardware
      Checks validity of an instance. Exact meaning can vary.
      Specified by:
      isValid in interface IHarcHardware
      Returns:
      validity of the instance.

    • open

      public void open() throws HarcHardwareException, IOException
      Description copied from interface: IHarcHardware
      Opens the device with previously set parameters.
      Specified by:
      open in interface IHarcHardware
      Throws:
      HarcHardwareException
      IOException

    • ready

      public boolean ready() throws IOException
      Description copied from interface: ICommandLineDevice
      Tells whether this stream is ready to be read. A buffered character stream is ready if the buffer is not empty, or if the underlying character stream is ready.
      Specified by:
      ready in interface ICommandLineDevice
      Returns:
      True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.
      Throws:
      IOException - If an I/O error occurs

    • flushInput

      public void flushInput() throws IOException
      Specified by:
      flushInput in interface ICommandLineDevice
      Throws:
      IOException