com.ergotech.vib.ports

Class Port

java.lang.Object

com.ergotech.vib.ports.Port

All Implemented Interfaces:

PortInterface

Direct Known Subclasses:

ControlLogixEthernetDeviceServer.EIPPort, SerialWrapper, TCPActiveSocket, TCPPassiveSocket, UDPSocket

public abstract class Port
extends java.lang.Object
implements PortInterface

This will wrap a serial port and allow us to read and write to it as a port interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev

Constructor Summary

Constructors

Constructor and Description
Port()

Method Summary

Modifier and Type	Method and Description
int	available() This will return the number of bytes available.
java.io.InputStream	getInputStream() The input stream associated with this port.
java.lang.String	getName() Returns the name of this component.
java.io.OutputStream	getOutputStream() The output stream associated with this port.
int	getPort() This is the port number.
PortPoolInterface	getPortPool() Returns the port pool that this port was served from.
boolean	hasError() Returns true if an error has been detected on the port.
int	read() This will read a single byte.
int	read(byte[] b) This will read an array of bytes and place them into the given array.
int	read(byte[] b, int off, int len) This will read an array of bytes and place them into the array of bytes at a given offset (up to the length).
byte[]	readAndWait(int length, int timeout, int interCharacterTimeout) This will wait until we have received data until either the timeout or the interCharacterTimeout expire or length characters are read.
byte[]	readCurrent() This will create a byte array of the current size of the buffer (filled).
void	setError(java.lang.Object errorObject) Sets an error on the port.
void	setInputStream(java.io.InputStream is) The input stream associated with this port.
void	setOutputStream(java.io.OutputStream os) The output stream associated with this port.
void	setPortPool(PortPoolInterface portPool) Sets the port pool that this port was served from.
void	setThread(java.lang.Thread thread) Set the thread that owns this port.
void	write(byte b) This will write a single byte.
void	write(byte[] b) This will write a single byte.
void	write(byte[] b, int offset, int length) This will write an array of bytes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ergotech.vib.ports.PortInterface

close

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

Constructor Detail

Port

public Port()

Method Detail

available

public int available()
              throws java.io.IOException

This will return the number of bytes available.

Specified by:

available in interface PortInterface

Throws:

java.io.IOException

getInputStream

public java.io.InputStream getInputStream()

The input stream associated with this port.

Returns:

the input stream

getName

public java.lang.String getName()

Returns the name of this component. This is immutable, that is, it is set on the constructor and cannot be changed.

Specified by:

getName in interface PortInterface

getOutputStream

public java.io.OutputStream getOutputStream()

The output stream associated with this port.

Returns:

the output stream

getPort

public int getPort()

This is the port number. This is immutable, that is, it is set on the constructor and cannot be changed.

getPortPool

public PortPoolInterface getPortPool()

Returns the port pool that this port was served from. May be null if the port is not currently checked out.

Specified by:

getPortPool in interface PortInterface

hasError

public boolean hasError()

Returns true if an error has been detected on the port.

Specified by:

hasError in interface PortInterface

Returns:

read

public int read()
         throws java.io.IOException

This will read a single byte.

Specified by:

read in interface PortInterface

Throws:

java.io.IOException

read

public int read(byte[] b)
         throws java.io.IOException

This will read an array of bytes and place them into the given array.

Specified by:

read in interface PortInterface

Throws:

java.io.IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException

This will read an array of bytes and place them into the array of bytes at a given offset (up to the length). It will return the number of bytes read.

Specified by:

read in interface PortInterface

Throws:

java.io.IOException

readAndWait

public byte[] readAndWait(int length,
                          int timeout,
                          int interCharacterTimeout)
                   throws java.io.IOException

This will wait until we have received data until either the timeout or the interCharacterTimeout expire or length characters are read. The timeout values are in milliseconds. The call will wait for up to timeout for a character to be available. If no characters are available then the method will return with a null value. If character are available, then the method will read characters until either length characters have been read or no characters have been available for interCharacterTimeout milliseconds. If the interCharacterTimeout expires then the returned array may have less than length characters available.

Specified by:

readAndWait in interface PortInterface

Parameters:

length - the maximum number of characters to read

timeout - the maximum time to wait for the first character to be available at the port

interCharacterTimeout - the maximum time to wait for subsequent characters to be available at the port

Returns:

an array of bytes read from the port. This may be less than length if the interCharacterTimeout expired. It will be null if the timeout expired.

Throws:

java.io.IOException - thrown by the underlying port

readCurrent

public byte[] readCurrent()
                   throws java.io.IOException

This will create a byte array of the current size of the buffer (filled).

Throws:

java.io.IOException

setError

public void setError(java.lang.Object errorObject)

Sets an error on the port. Error Object may be null.

Specified by:

setError in interface PortInterface

setInputStream

public void setInputStream(java.io.InputStream is)

The input stream associated with this port.

setOutputStream

public void setOutputStream(java.io.OutputStream os)

The output stream associated with this port.

setPortPool

public void setPortPool(PortPoolInterface portPool)

Sets the port pool that this port was served from. May be set to null if the port is checked in.

Specified by:

setPortPool in interface PortInterface

setThread

public void setThread(java.lang.Thread thread)

Set the thread that owns this port.

Specified by:

setThread in interface PortInterface

write

public void write(byte b)
           throws java.io.IOException

This will write a single byte.

Specified by:

write in interface PortInterface

Throws:

java.io.IOException

write

public void write(byte[] b)
           throws java.io.IOException

This will write a single byte.

Specified by:

write in interface PortInterface

Throws:

java.io.IOException

write

public void write(byte[] b,
                  int offset,
                  int length)
           throws java.io.IOException

This will write an array of bytes.

Specified by:

write in interface PortInterface

Throws:

java.io.IOException