com.ergotech.vib.ports

Interface PortInterface

All Known Implementing Classes:

ControlLogixEthernetDeviceServer.EIPPort, PCCCRegisteredSocket, Port, SerialWrapper, SLCRegisteredSocket, TCPActiveSocket, TCPPassiveSocket, UDPActiveSocket, UDPPassiveSocket, UDPSocket

public interface PortInterface

This interface can wrap any type of port. With standard open/close/read/write etc.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
int	available() This will return the number of bytes available.
void	close() This will close a port.
java.lang.String	getName() This should return the name of the port (in a nice short form).
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 offset, int length) 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 what the port thinks is everything.
void	setError(java.lang.Object errorObject) Sets an error on the port.
void	setPortPool(PortPoolInterface portPool) Sets the port pool that this port was served from.
void	setThread(java.lang.Thread thread) The thread that currently owns the port.
void	write(byte b) This will write a single byte.
void	write(byte[] b) This will write an array of bytes.
void	write(byte[] b, int offset, int length) This will write an array of bytes starting at offset for length number of bytes.

Field Detail

cvsRev

static final java.lang.String cvsRev

See Also:

Constant Field Values

Method Detail

available

int available()
       throws java.io.IOException

This will return the number of bytes available.

Throws:

java.io.IOException

close

void close()

This will close a port.

getName

java.lang.String getName()

This should return the name of the port (in a nice short form). For more information on the port, you should call toString().

getPortPool

PortPoolInterface getPortPool()

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

hasError

boolean hasError()

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

Returns:

true if there is an error on the port.

read

int read()
  throws java.io.IOException

This will read a single byte.

Throws:

java.io.IOException

read

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

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

Throws:

java.io.IOException

read

int read(byte[] b,
         int offset,
         int length)
  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.

Throws:

java.io.IOException

readAndWait

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

This will wait until we have received what the port thinks is everything.

Throws:

java.io.IOException

setError

void setError(java.lang.Object errorObject)

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

setPortPool

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.

setThread

void setThread(java.lang.Thread thread)

The thread that currently owns the port.

write

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

This will write a single byte.

Throws:

java.io.IOException

write

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

This will write an array of bytes.

Throws:

java.io.IOException

write

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

This will write an array of bytes starting at offset for length number of bytes.

Throws:

java.io.IOException