com.ergotech.vib.ports

Class UDPSocket

java.lang.Object

com.ergotech.vib.ports.Port

com.ergotech.vib.ports.UDPSocket

All Implemented Interfaces:

PortInterface

Direct Known Subclasses:

UDPActiveSocket, UDPPassiveSocket

public abstract class UDPSocket
extends Port

This will wrap a socket. This is an active socket and so will initiate a connection.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
UDPSocket()

Method Summary

Modifier and Type	Method and Description
int	available() If no bytes are available from the existing input stream, then this method will read a complete new packet.
void	close() This will close the socket and the streams.
int	getReceiveBufferSize() Returns the receiveBufferSize for the current socket.
int	read() Forces a packet read with available() and then calls the superclass.
int	read(byte[] b) Forces a packet read with available() and then calls the superclass.
int	read(byte[] b, int off, int len) Forces a packet read with available() and then calls the superclass.
byte[]	readAndWait(int length, int timeout, int interCharacterTimeout) This method returns a copy of the byte array from the socket.
void	write(byte[] b) Pass through to write(b, offset, length).

Methods inherited from class com.ergotech.vib.ports.Port

getInputStream, getName, getOutputStream, getPort, getPortPool, hasError, readCurrent, setError, setInputStream, setOutputStream, setPortPool, setThread, write, write

Methods inherited from class java.lang.Object

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

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

Constructor Detail

UDPSocket

public UDPSocket()

Method Detail

available

public int available()
              throws java.io.IOException

If no bytes are available from the existing input stream, then this method will read a complete new packet.

Specified by:

available in interface PortInterface

Overrides:

available in class Port

Throws:

java.io.IOException

See Also:

vib.utils.PortInterface#available()

close

public void close()

This will close the socket and the streams.

getReceiveBufferSize

public int getReceiveBufferSize()

Returns the receiveBufferSize for the current socket.

read

public int read()
         throws java.io.IOException

Forces a packet read with available() and then calls the superclass.

Specified by:

read in interface PortInterface

Overrides:

read in class Port

Throws:

java.io.IOException

See Also:

vib.utils.PortInterface#read()

read

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

Forces a packet read with available() and then calls the superclass.

Specified by:

read in interface PortInterface

Overrides:

read in class Port

Throws:

java.io.IOException

See Also:

vib.utils.PortInterface#read(byte[])

read

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

Forces a packet read with available() and then calls the superclass.

Specified by:

read in interface PortInterface

Overrides:

read in class Port

Throws:

java.io.IOException

See Also:

vib.utils.PortInterface#read(byte[], int, int)

readAndWait

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

This method returns a copy of the byte array from the socket. This will work optimally if the amount of data to be read is small. If no characters have been recieved before timeout expires then the method returns null.

Specified by:

readAndWait in interface PortInterface

Overrides:

readAndWait in class Port

Parameters:

length - this is ignored provided that it is less than socket.getReceiveBufferSize()

timeout - the soTimeout of the socket is set to this value before receive is called.

interCharacterTimeout - this parameter is ignored

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

See Also:

vib.utils.PortInterface#readAndWait(int, int, int)

write

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

Pass through to write(b, offset, length).

Specified by:

write in interface PortInterface

Overrides:

write in class Port

Throws:

java.io.IOException

See Also:

vib.utils.PortInterface#write(byte[])