com.ergotech.secs

Class SerialPortManager

java.lang.Object

com.ergotech.secs.PortManager

com.ergotech.secs.SerialPortManager

public class SerialPortManager
extends PortManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev
static int	defaultBaudRate The default baud rate.

Fields inherited from class com.ergotech.secs.PortManager

allIDsValid

Constructor Summary

Constructors

Constructor and Description
SerialPortManager(int portNumber, int baudRate) Creates the SECS1 port manager.
SerialPortManager(int portNumber, java.lang.String connectionId) Creates the SECS1 port manager.

Method Summary

Modifier and Type	Method and Description
int	available() Returns the number of bytes available.
void	close() Close the socket manager.
void	configurePort() Open the port and set up the object to receive events.
int	getBaudRate() Gets the port value of the server.
java.lang.String	getName() Gets the name of this serial port on this computer.
int	getPort() Gets the port value of the server.
int	read(byte[] b, int off, int len) Read the socket.
void	setBaudRate(int newValue) Sets the baud rate for the server.
void	setPort(int newValue) Sets the port number of the server.
java.lang.String	toString() Return the string representation of this object.
void	write(byte[] b) Writes the array to the socket.

Methods inherited from class com.ergotech.secs.PortManager

addDeviceId, addPortManager, getConnectionManager, getConnectionManagerForId, getId, getLogger, getMessageHandlersForId, getPortManagerForId, getPortManagers, read, removeDeviceId, removePortManager, removeSessionId, setConnectionManager, setLogger, write

Methods inherited from class java.lang.Object

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

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

defaultBaudRate

public static int defaultBaudRate

The default baud rate.

Constructor Detail

SerialPortManager

public SerialPortManager(int portNumber,
                         int baudRate)
                  throws java.io.IOException

Creates the SECS1 port manager. The port number is simply counted through an enumeration of ports, hopefully starting a the first port. So 0 would be COM1: in Windows, /dev/ttyS0 on Linux and so on.

Parameters:

portNumber - serial port enumeration

baudRate - a valid baud rate

Throws:

java.io.IOException

SerialPortManager

public SerialPortManager(int portNumber,
                         java.lang.String connectionId)
                  throws java.io.IOException

Creates the SECS1 port manager. This is a required constructor used by SessionManager.

Throws:

java.io.IOException

See Also:

SessionManager.getSessionManager(int, java.lang.String, int, int, boolean, java.lang.Class)

Method Detail

available

public int available()
              throws java.io.IOException

Returns the number of bytes available.

Specified by:

available in class PortManager

Returns:

is.available()

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Close the socket manager. This closes all the streams and the socket.

Specified by:

close in class PortManager

Throws:

java.io.IOException

configurePort

public void configurePort()
                   throws java.io.IOException

Open the port and set up the object to receive events.

Throws:

java.io.IOException

getBaudRate

public int getBaudRate()

Gets the port value of the server. Returns the port

getName

public java.lang.String getName()

Gets the name of this serial port on this computer. Returns the port

getPort

public int getPort()

Gets the port value of the server. Returns the port

Overrides:

getPort in class PortManager

read

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

Read the socket.

Specified by:

read in class PortManager

Throws:

java.io.IOException

See Also:

read

setBaudRate

public void setBaudRate(int newValue)
                 throws java.io.IOException

Sets the baud rate for the server.

Parameters:

newValue - The new baud rate

Throws:

java.io.IOException

setPort

public void setPort(int newValue)
             throws java.io.IOException

Sets the port number of the server. The port number is simply counted through an enumeration of ports, hopefully starting a the first port. So 0 would be COM1: in Windows, /dev/ttyS0 on Linux and so on.

Overrides:

setPort in class PortManager

Parameters:

newValue - the new port number

Throws:

java.io.IOException

toString

public java.lang.String toString()

Return the string representation of this object.

Overrides:

toString in class java.lang.Object

write

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

Writes the array to the socket.

Specified by:

write in class PortManager

Throws:

java.io.IOException