HSMSPassiveWrapper (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.secs.HSMSWrapper
- - com.ergotech.secs.HSMSPassiveWrapper

All Implemented Interfaces:

SecsEventListener, WrapperInterface, java.io.Serializable, java.util.EventListener
```
public class HSMSPassiveWrapper
extends HSMSWrapper
```
See Also:

Serialized Form

Field Summary
- Fields inherited from interface com.ergotech.secs.WrapperInterface
  cvsRev

Constructor Summary

Constructors
Constructor and Description
`HSMSPassiveWrapper(int port)` Create the passive wrapper for the particular TCP/IP port.
`HSMSPassiveWrapper(int port, int deviceId)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMessageHandler(java.lang.Object messageHandler)` Add a message handler object.
`void`	`addMessageHandler(java.io.Serializable messageHandler)` Add a message handler object.
`boolean`	`connect()` Connected the session.
`java.lang.String`	`connectedHost()`
`void`	`disconnect()` Disconnect the connection.
`java.util.Vector`	`getAllSessions()` This will return back a Vector of SessionManagers associated with this connection.
`int`	`getConnectionLimit()` Returns the current connection limit.
`SessionManager`	`getSessionManager(int deviceId)` Get a session manager for the provided deviceID.
`HSMSSocketListener`	`getSocketManager()` Returns the socket manager for the current parameters.
`boolean`	`initializeConnection()` Connected the session.
`void`	`listenForConnections()`
`void`	`removeMessageHandler(java.lang.Object messageHandler)` Remove a message handler object.
`void`	`setConnectionLimit(int connectionLimit)` Set the connection limit.
`void`	`setDeviceId(int newValue)` Sets the device id for this wrapper.
`void`	`setLogger(LoggerInterface l)` Sets the logger for the current connection.
`java.lang.String`	`toString()` Returns an description of this object.

Methods inherited from class com.ergotech.secs.HSMSWrapper
destroy, getDefaultLinkTestInterval, getDeviceId, getLinkTestInterval, getLogger, getMessageHandlers, getPort, getPortManager, getRawSessionManager, getSessionManager, getT3, getT5, getT6, getT7, getT8, init, secsEvent, setActive, setDefault, setDefaultLinkTestInterval, setLinkTestInterval, setPort, setPortManager, setT3, setT5, setT6, setT7, setT8, start, stop

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HSMSPassiveWrapper
```
public HSMSPassiveWrapper(int port)
```
    Create the passive wrapper for the particular TCP/IP port.
  - HSMSPassiveWrapper
```
public HSMSPassiveWrapper(int port,
                          int deviceId)
```
- Method Detail
  - addMessageHandler
```
public void addMessageHandler(java.lang.Object messageHandler)
```
    Add a message handler object. This will be added to all future session managers that are created.
    
    Specified by:
    
    addMessageHandler in interface WrapperInterface
    
    Overrides:
    
    addMessageHandler in class HSMSWrapper
    
    Parameters:
    
    messageHandler - the message handler to add
    
    See Also:
    
    SecsMsg.processSelf(java.lang.Object)
  - addMessageHandler
```
public void addMessageHandler(java.io.Serializable messageHandler)
```
    Add a message handler object. This will be added to all future session managers that are created.
    
    Specified by:
    
    addMessageHandler in interface WrapperInterface
    
    Overrides:
    
    addMessageHandler in class HSMSWrapper
    
    Parameters:
    
    messageHandler - the message handler to add
    
    See Also:
    
    SecsMsg.processSelf(java.lang.Object)
  - connect
```
public boolean connect()
```
    Connected the session. Use initializeConnection instead it provides an exception indicating the reason for failure.
    
    Specified by:
    
    connect in interface WrapperInterface
    
    Specified by:
    
    connect in class HSMSWrapper
  - connectedHost
```
public java.lang.String connectedHost()
```
    Parameters:
    
    connectionAddress -
    
    Returns:
  - disconnect
```
public void disconnect()
```
    Disconnect the connection. This will close the connection and will cause all the objects associated with the connection to be garbage collected.
    
    Specified by:
    
    disconnect in interface WrapperInterface
    
    Overrides:
    
    disconnect in class HSMSWrapper
  - 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()
```
    Returns the current connection limit.
  - getSessionManager
```
public SessionManager getSessionManager(int deviceId)
```
    Get a session manager for the provided deviceID.
    
    Specified by:
    
    getSessionManager in interface WrapperInterface
    
    Overrides:
    
    getSessionManager in class HSMSWrapper
    
    Parameters:
    
    deviceId - the deviceId
  - getSocketManager
```
public HSMSSocketListener getSocketManager()
```
    Returns the socket manager for the current parameters.
    
    Returns:
    
    the socket manager.
  - initializeConnection
```
public boolean initializeConnection()
                             throws SecsException
```
    Description copied from interface: WrapperInterface
    
    Connected the session.
    
    Throws:
    
    SecsException
  - listenForConnections
```
public void listenForConnections()
                          throws SecsException
```
    Throws:
    
    SecsException
  - removeMessageHandler
```
public void removeMessageHandler(java.lang.Object messageHandler)
```
    Remove a message handler object.
    
    Specified by:
    
    removeMessageHandler in interface WrapperInterface
    
    Overrides:
    
    removeMessageHandler in class HSMSWrapper
    
    Parameters:
    
    messageHandler - the message handler to add
    
    See Also:
    
    SecsMsg.processSelf(java.lang.Object)
  - setConnectionLimit
```
public void setConnectionLimit(int connectionLimit)
```
    Set the connection limit. The socket will accept as valid only this number of connections.
    
    Parameters:
    
    connectionLimit - the new connection limit
    
    See Also:
    
    HSMSSocketManager.setConnectionLimit(int)
  - setDeviceId
```
public void setDeviceId(int newValue)
```
    Description copied from class: HSMSWrapper
    
    Sets the device id for this wrapper.
    
    Specified by:
    
    setDeviceId in interface WrapperInterface
    
    Overrides:
    
    setDeviceId in class HSMSWrapper
    
    See Also:
    
    WrapperInterface.setDeviceId(int)
  - setLogger
```
public void setLogger(LoggerInterface l)
```
    Description copied from class: HSMSWrapper
    
    Sets the logger for the current connection. This logger will be added to all future sessions created, it will not be set to existing sessions.
    
    Specified by:
    
    setLogger in interface WrapperInterface
    
    Overrides:
    
    setLogger in class HSMSWrapper
    
    Parameters:
    
    l - the logger to add.
  - toString
```
public java.lang.String toString()
```
    Returns an description of this object.
    
    Overrides:
    
    toString in class java.lang.Object

Class HSMSPassiveWrapper

Field Summary

Fields inherited from interface com.ergotech.secs.WrapperInterface

Constructor Summary

Method Summary

Methods inherited from class com.ergotech.secs.HSMSWrapper

Methods inherited from class java.lang.Object

Constructor Detail

HSMSPassiveWrapper

HSMSPassiveWrapper

Method Detail

addMessageHandler

addMessageHandler

connect

connectedHost

disconnect

getAllSessions

getConnectionLimit

getSessionManager

getSocketManager

initializeConnection

listenForConnections

removeMessageHandler

setConnectionLimit

setDeviceId

setLogger

toString