org.harctoolbox.harchardware.comm

Class UrlPort

java.lang.Object

org.harctoolbox.harchardware.comm.UrlPort

All Implemented Interfaces:

Closeable, AutoCloseable, IHarcHardware, IStringCommand

public class UrlPort
extends Object
implements IStringCommand

Constructor Summary

Constructors

Constructor and Description
UrlPort(String protocol, String hostIp, int portNumber, String prefix, String suffix, int timeout, boolean verbose)

Method Summary

Modifier and Type	Method and Description
void	close()
void	connect()
String	getVersion() Returns the hardware version (not the version of the driver software).
boolean	isValid() Tries to identify instances that are not valid.
static void	main(String[] args)
void	open() Opens the device with previously set parameters.
String	readString() Reads a line of text.
boolean	ready() Tells whether this stream is ready to be read.
void	sendString(String payload)
void	setDebug(int debug) Sets a debug parameter.
void	setTimeout(int timeout) Set timeout in milliseconds.
void	setVerbosity(boolean verbosity) Sets a verbosity flag, causing commands to be executed verbosely.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UrlPort

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

Method Detail

connect

public void connect()
             throws IOException

Throws:

IOException

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

sendString

public void sendString(String payload)
                throws IOException

Specified by:

sendString in interface IStringCommand

Throws:

IOException

readString

public String readString()

Description copied from interface: IStringCommand

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 IStringCommand

Returns:

A String containing the contents of the line, not including any line-termination characters, or null if no input available.

main

public static void main(String[] args)

Parameters:

args - the command line arguments

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

setVerbosity

public void setVerbosity(boolean verbosity)

Description copied from interface: IHarcHardware

Sets a verbosity flag, causing commands to be executed verbosely. Exact semantic depends on the implementation.

Specified by:

setVerbosity in interface IHarcHardware

Parameters:

verbosity - 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

Tries to identify instances that are not valid. 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: IStringCommand

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 IStringCommand

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