com.ergotech.secs

Class HSMSSocketManager

java.lang.Object

com.ergotech.secs.PortManager

com.ergotech.secs.HSMSSocketManager

public class HSMSSocketManager
extends PortManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PASSIVE_ID The id we use for passive connections.

Fields inherited from class com.ergotech.secs.PortManager

allIDsValid, cvsRev

Constructor Summary

Constructors

Constructor and Description
HSMSSocketManager(int newPort) Create an HSMSSocketManger to listen on a particular port.
HSMSSocketManager(int newPort, java.lang.String hostname) Create an HSMSSocketManger to listen on a particular port.

Method Summary

Modifier and Type	Method and Description
int	available() Returns the number of bytes available.
void	close() Close the socket manager.
void	closeListeningSocket() This will close the socketListener if it exists.
int	currentConnectionCount() Returns the number of current connections on this socket.
int	getConnectionLimit() Remove a connection manager from this socket manager.
java.lang.String	getHostName() Returns the host name.
java.lang.String	getId() Returns the remoteHostName and port.
java.net.InetAddress	getInetAddress() Return the inet address of the client socket
static LoggerInterface	getInitialLogger()
int	getPort() Gets the port for the server to listen on.
int	read(byte[] b, int off, int len) Read the socket.
void	setConnectionLimit(int newLimit) Sets the maximum number of allowable connections.
static void	setInitialLogger(LoggerInterface initialLogger)
void	setPort(int newPort) Sets the port for the server to listen on.
void	write(byte[] b) Writes the array to the socket.

Methods inherited from class com.ergotech.secs.PortManager

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

Methods inherited from class java.lang.Object

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

Field Detail

PASSIVE_ID

public static final java.lang.String PASSIVE_ID

The id we use for passive connections. This should not conflict with a hostname to avoid confusing passive and active ports. The default for this value is the string "PASSIVE CONNECTION".

See Also:

Constant Field Values

Constructor Detail

HSMSSocketManager

public HSMSSocketManager(int newPort)

Create an HSMSSocketManger to listen on a particular port.

HSMSSocketManager

public HSMSSocketManager(int newPort,
                         java.lang.String hostname)
                  throws java.io.IOException

Create an HSMSSocketManger to listen on a particular port.

Throws:

java.io.IOException

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

closeListeningSocket

public void closeListeningSocket()
                          throws java.io.IOException

This will close the socketListener if it exists.

Throws:

java.io.IOException

currentConnectionCount

public int currentConnectionCount()

Returns the number of current connections on this socket.

getConnectionLimit

public int getConnectionLimit()

Remove a connection manager from this socket manager.

See Also:

HSMSConnectionManager

getHostName

public java.lang.String getHostName()

Returns the host name. This will return the string stored in the PASSIVE_ID for passive entities and the name provided for the name of the remote host.

getId

public java.lang.String getId()

Returns the remoteHostName and port. This will always be the string stored in the variable PASSIVE_ID for passive connections.

Overrides:

getId in class PortManager

Returns:

the id of this port manager.

getInetAddress

public java.net.InetAddress getInetAddress()

Return the inet address of the client socket

getInitialLogger

public static LoggerInterface getInitialLogger()

Returns:

Returns the initialLogger.

getPort

public int getPort()

Gets the port for the server to listen on.

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

setConnectionLimit

public void setConnectionLimit(int newLimit)

Sets the maximum number of allowable connections.

setInitialLogger

public static void setInitialLogger(LoggerInterface initialLogger)

Parameters:

initialLogger - The initialLogger to set.

setPort

public void setPort(int newPort)

Sets the port for the server to listen on.

Overrides:

setPort in class PortManager

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