HSMSSocketListener (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.secs.HSMSSocketListener

All Implemented Interfaces:

SimulationListener, java.lang.Runnable
```
public class HSMSSocketListener
extends java.lang.Object
implements java.lang.Runnable, SimulationListener
```
This object listens for connections on a socket. If a connection is received and passes any security checks (not yet implemented) then the object will create an HSMSSocketManager to handle the SECS connection over the socket.

See Also:

HSMSSocketManager

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String cvsRev

static boolean globalSimulation
This variable will be true if we are simulating.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`cvsRev`
`static boolean`	`globalSimulation` This variable will be true if we are simulating.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMessageHandler(int deviceId, java.lang.Object messageHandlerObject)` Add a message handler for this connection.
`void`	`closeListeningSocket()` Close the listening socket manager.
`void`	`closeListeningSocket(boolean removeListener)` Close the listening socket manager.
`java.util.Vector`	`getAllSessions()` This will return back a Vector of SessionManagers associated with this connection.
`int`	`getConnectionLimit()` Remove a connection manager from this socket manager.
`static HSMSSocketListener`	`getHSMSSocketListener(int port)` Returns a Socket Listener for the port provided.
`LoggerInterface`	`getLogger()` Returns the logger for this connection.
`java.util.Hashtable`	`getMessageHandlers()` Returns the Vector of message handlers.
`int`	`getPort()` Returns the port that we are listening on.
`SessionManager`	`getSessionManager(int deviceId)` This will return a session manager for the give id, if we spawned it.
`boolean`	`isSimulating()`
`boolean`	`isSimulationFlag()`
`void`	`removeMessageHandler(int deviceId, java.lang.Object messageHandlerObject)` Remove a message handler from this connection.
`void`	`run()` runs the server and waits for input on the selected port.
`void`	`setConnectionLimit(int newLimit)` Sets the maximum number of allowable connections.
`void`	`setLogger(LoggerInterface logger)` Set the logger for this connection.
`void`	`setSimulationFlag(boolean simulationFlag)` Sets the state of the simulation flag.
`void`	`simulationStateChanged(SimulationChangedEvent simulationChangedEvent)` Changes the state of the simulation mode.
`java.lang.String`	`toString()`

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
  - globalSimulation
```
public static boolean globalSimulation
```
    This variable will be true if we are simulating. This defaults to simulating.
- Method Detail
  - addMessageHandler
```
public void addMessageHandler(int deviceId,
                              java.lang.Object messageHandlerObject)
```
    Add a message handler for this connection.
  - closeListeningSocket
```
public void closeListeningSocket()
                          throws java.io.IOException
```
    Close the listening socket manager.
    
    Throws:
    
    java.io.IOException
  - closeListeningSocket
```
public void closeListeningSocket(boolean removeListener)
                          throws java.io.IOException
```
    Close the listening socket manager.
    
    Parameters:
    
    removeListener - true if this port should be removed from the socket listeners this is the case on a true close, but the port is not removed when moving into a simulation state.
    
    Throws:
    
    java.io.IOException
  - getAllSessions
```
public java.util.Vector getAllSessions()
```
    This will return back a Vector of SessionManagers associated with this connection. This will return an empty vector if nothing is connected.
  - getConnectionLimit
```
public int getConnectionLimit()
```
    Remove a connection manager from this socket manager.
    
    See Also:
    
    HSMSConnectionManager
  - getHSMSSocketListener
```
public static HSMSSocketListener getHSMSSocketListener(int port)
                                                throws java.io.IOException
```
    Returns a Socket Listener for the port provided.
    
    Throws:
    
    java.io.IOException
  - getLogger
```
public LoggerInterface getLogger()
```
    Returns the logger for this connection.
  - getMessageHandlers
```
public java.util.Hashtable getMessageHandlers()
```
    Returns the Vector of message handlers.
  - getPort
```
public int getPort()
```
    Returns the port that we are listening on.
  - getSessionManager
```
public SessionManager getSessionManager(int deviceId)
```
    This will return a session manager for the give id, if we spawned it. It will return null if the session manager does not exist or is not associated with this connection.
  - isSimulating
```
public boolean isSimulating()
```
    Returns:
    
    Returns the simulation.
  - isSimulationFlag
```
public boolean isSimulationFlag()
```
    Returns:
    
    Returns the simulation.
  - removeMessageHandler
```
public void removeMessageHandler(int deviceId,
                                 java.lang.Object messageHandlerObject)
```
    Remove a message handler from this connection.
  - run
```
public void run()
```
    runs the server and waits for input on the selected port. When a connection is accepted it will start processing on that connection. In general it will create a new instance of this object to do that. For the first connection it simply configures this object and registers it.
    
    Specified by:
    
    run in interface java.lang.Runnable
  - setConnectionLimit
```
public void setConnectionLimit(int newLimit)
```
    Sets the maximum number of allowable connections.
  - setLogger
```
public void setLogger(LoggerInterface logger)
```
    Set the logger for this connection.
  - setSimulationFlag
```
public void setSimulationFlag(boolean simulationFlag)
```
    Sets the state of the simulation flag.
    
    Specified by:
    
    setSimulationFlag in interface SimulationListener
    
    Parameters:
    
    simulationFlag - will be written as "false" when code is generated.
  - simulationStateChanged
```
public void simulationStateChanged(SimulationChangedEvent simulationChangedEvent)
                            throws java.lang.Exception
```
    Changes the state of the simulation mode. If this flag is true, then any existing connections will be closed and no new connections will be opened. The flag should be false for normal operation.
    
    Specified by:
    
    simulationStateChanged in interface SimulationListener
    
    Throws:
    
    java.lang.Exception - TODO
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    
    Object.toString()

Class HSMSSocketListener

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cvsRev

globalSimulation

Method Detail

addMessageHandler

closeListeningSocket

closeListeningSocket

getAllSessions

getConnectionLimit

getHSMSSocketListener

getLogger

getMessageHandlers

getPort

getSessionManager

isSimulating

isSimulationFlag

removeMessageHandler

run

setConnectionLimit

setLogger

setSimulationFlag

simulationStateChanged

toString