org.harctoolbox.harchardware.comm

Class TcpSocketChannel

java.lang.Object

org.harctoolbox.harchardware.comm.TcpSocketChannel

All Implemented Interfaces:

Closeable, AutoCloseable, IBytesCommand, IHarcHardware, IStringCommand

public class TcpSocketChannel
extends Object
implements IStringCommand, IBytesCommand

This a helper class, to bundle the socket operations in a unified manner. It can be instantiated, possibly in multiple instances. It is not meant to be inherited from, or exported. It should therefore throw low-level exceptions, not HarcHardwareException.

Constructor Summary

Constructors

Constructor and Description
TcpSocketChannel(InetAddress inetAddress, int portNumber, int timeout, boolean verbose, TcpSocketPort.ConnectionMode connectionMode)
TcpSocketChannel(String hostIp, int portNumber, int timeout, boolean verbose, TcpSocketPort.ConnectionMode connectionMode)

Method Summary

Modifier and Type	Method and Description
void	close()
void	close(boolean force)
void	connect()
BufferedReader	getBufferedIn()
InputStream	getIn()
OutputStream	getOut()
String	getVersion() Returns the hardware version (not the version of the driver software).
boolean	isValid() Tries to identify instances that are not valid.
void	open() Opens the device with previously set parameters.
byte[]	readBytes(int length)
String	readString() Reads a line of text.
boolean	ready() Tells whether this stream is ready to be read.
void	sendBytes(byte[] cmd)
void	sendString(String cmd)
void	setDebug(int debug) Sets a debug parameter.
void	setTimeout(int timeout) Set timeout in milliseconds.
void	setVerbosity(boolean verbose) 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

TcpSocketChannel

public TcpSocketChannel(String hostIp,
                        int portNumber,
                        int timeout,
                        boolean verbose,
                        TcpSocketPort.ConnectionMode connectionMode)
                 throws UnknownHostException

Parameters:

hostIp -

portNumber -

timeout -

verbose -

connectionMode -

Throws:

UnknownHostException

TcpSocketChannel

public TcpSocketChannel(InetAddress inetAddress,
                        int portNumber,
                        int timeout,
                        boolean verbose,
                        TcpSocketPort.ConnectionMode connectionMode)

Parameters:

inetAddress -

portNumber -

timeout -

verbose -

connectionMode -

Method Detail

connect

public void connect()
             throws IOException

Throws:

IOException

close

public void close(boolean force)
           throws IOException

Parameters:

force -

Throws:

IOException

getOut

public OutputStream getOut()

getIn

public InputStream getIn()

getBufferedIn

public BufferedReader getBufferedIn()

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.

setTimeout

public void setTimeout(int timeout)
                throws SocketException

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.

Throws:

SocketException

setVerbosity

public void setVerbosity(boolean verbose)

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:

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

sendString

public void sendString(String cmd)
                throws IOException

Specified by:

sendString in interface IStringCommand

Throws:

IOException

readString

public String readString()
                  throws IOException

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.

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

sendBytes

public void sendBytes(byte[] cmd)
               throws IOException

Specified by:

sendBytes in interface IBytesCommand

Throws:

IOException

readBytes

public byte[] readBytes(int length)
                 throws IOException

Specified by:

readBytes in interface IBytesCommand

Throws:

IOException

getVersion

public String getVersion()

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.

open

public void open()

Description copied from interface: IHarcHardware

Opens the device with previously set parameters.

Specified by:

open in interface IHarcHardware

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