HSMSWrapper (ErgoTech VIB/TransSECS Scripting API)

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

All Implemented Interfaces:

SecsEventListener, WrapperInterface, java.io.Serializable, java.util.EventListener

Direct Known Subclasses:

HSMSActiveWrapper, HSMSPassiveWrapper
```
public abstract class HSMSWrapper
extends java.lang.Object
implements java.io.Serializable, SecsEventListener, WrapperInterface
```
See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

HSMSWrapper(int port, int deviceId)
Create the passive wrapper for the particular TCP/IP port.

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

Method Summary

All Methods Static Methods Instance Methods Abstract 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.
`abstract boolean`	`connect()` Connected the session.
`void`	`destroy()`
`void`	`disconnect()` Disconnect the connection.
`static double`	`getDefaultLinkTestInterval()` Sets the default link test interval.
`int`	`getDeviceId()` Returns the current device id.
`double`	`getLinkTestInterval()` This value controls how often LinkTest messages are sent.
`LoggerInterface`	`getLogger()` Returns the current logger.
`java.util.List<java.lang.Object>`	`getMessageHandlers()` Return the list of message handlers.
`int`	`getPort()` Returns the current TCP/IP port.
`PortManager`	`getPortManager()` Returns the port manager for the wrapper.
`SessionManager`	`getRawSessionManager(int deviceId)` Get a session manager for the provided deviceID.
`SessionManager`	`getSessionManager()` This will return the SessionManager if one exists.
`SessionManager`	`getSessionManager(int deviceId)` Get a session manager for the provided deviceID.
`double`	`getT3()` Returns the reply timeout.
`int`	`getT5()`
`int`	`getT6()`
`int`	`getT7()`
`int`	`getT8()`
`void`	`init()`
`void`	`removeMessageHandler(java.lang.Object messageHandler)` Remove a message handler object.
`void`	`secsEvent(SecsEvent theEvent)` Catches incoming PORT_ERROR and SESSION_CREATED events and removes the portManager.
`void`	`setActive(boolean flag)` Determines whether newly created sessions should be set to the active session.
`void`	`setDefault(boolean flag)` Determines whether newly created sessions should be set to the default session.
`static void`	`setDefaultLinkTestInterval(double defaultLinkTestInterval)` Sets the default link test interval.
`void`	`setDeviceId(int newValue)` Sets the device id for this wrapper.
`void`	`setLinkTestInterval(double linkTestInterval)` This value controls how often LinkTest messages are sent.
`void`	`setLogger(LoggerInterface theLogger)` Sets the logger for the current connection.
`void`	`setPort(int port)` Set the TCP/IP port to listen/connect on.
`void`	`setPortManager(PortManager pm)` Sets the port manager for the wrapper.
`void`	`setT3(double newValue)` Sets the reply timeout.
`void`	`setT5(int newValue)`
`void`	`setT6(int newValue)`
`void`	`setT7(int newValue)`
`void`	`setT8(int newValue)`
`void`	`start()`
`void`	`stop()`

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

Methods inherited from interface com.ergotech.secs.WrapperInterface
initializeConnection

- Constructor Detail
  - HSMSWrapper
```
public HSMSWrapper(int port,
                   int deviceId)
```
    Create the passive wrapper for the particular TCP/IP port.
- 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. It will not be added to existing session managers.
    
    Specified by:
    
    addMessageHandler in interface WrapperInterface
    
    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. It will not be added to existing session managers.
    
    Specified by:
    
    addMessageHandler in interface WrapperInterface
    
    Parameters:
    
    messageHandler - the message handler to add
    
    See Also:
    
    SecsMsg.processSelf(java.lang.Object)
  - connect
```
public abstract boolean connect()
```
    Connected the session. Use initializeConnection instead it provides an exception indicating the reason for failure.
    
    Specified by:
    
    connect in interface WrapperInterface
  - destroy
```
public void destroy()
             throws BadParameterException
```
    Throws:
    
    BadParameterException
  - 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
  - getDefaultLinkTestInterval
```
public static double getDefaultLinkTestInterval()
```
    Sets the default link test interval. This link test interval for any newly created object will be set to this.
  - getDeviceId
```
public int getDeviceId()
```
    Returns the current device id.
    
    Specified by:
    
    getDeviceId in interface WrapperInterface
    
    Returns:
    
    the device id.
  - getLinkTestInterval
```
public double getLinkTestInterval()
```
    This value controls how often LinkTest messages are sent. The value is in seconds. A value > 1 will cause LinkTest messages to be sent with that interval between message attempts.
    
    See Also:
    
    LinkTest
  - getLogger
```
public LoggerInterface getLogger()
```
    Returns the current logger.
    
    Specified by:
    
    getLogger in interface WrapperInterface
    
    Returns:
    
    the current logger.
  - getMessageHandlers
```
public java.util.List<java.lang.Object> getMessageHandlers()
```
    Description copied from interface: WrapperInterface
    
    Return the list of message handlers.
    
    Specified by:
    
    getMessageHandlers in interface WrapperInterface
  - getPort
```
public int getPort()
```
    Returns the current TCP/IP port.
    
    Specified by:
    
    getPort in interface WrapperInterface
    
    Returns:
    
    the TCP/IP port.
  - getPortManager
```
public PortManager getPortManager()
```
    Returns the port manager for the wrapper. May be null if there is no connection.
    
    Specified by:
    
    getPortManager in interface WrapperInterface
    
    Returns:
    
    the port manager.
  - getRawSessionManager
```
public SessionManager getRawSessionManager(int deviceId)
                                    throws SecsException
```
    Get a session manager for the provided deviceID. If the session manager does not exist it will be created. This method defaults to HSMS-Single Session. (SessionId is always 0xFFFF).
    
    Parameters:
    
    deviceId - the deviceId
    
    Throws:
    
    SecsException
  - getSessionManager
```
public SessionManager getSessionManager()
```
    This will return the SessionManager if one exists. This WILL NOT CREATE ONE.
    
    Specified by:
    
    getSessionManager in interface WrapperInterface
  - getSessionManager
```
public SessionManager getSessionManager(int deviceId)
```
    Get a session manager for the provided deviceID. If the session manager does not exist it will be created.
    
    Specified by:
    
    getSessionManager in interface WrapperInterface
    
    Parameters:
    
    deviceId - the deviceId
  - getT3
```
public double getT3()
```
    Description copied from interface: WrapperInterface
    
    Returns the reply timeout.
    
    Specified by:
    
    getT3 in interface WrapperInterface
  - getT5
```
public int getT5()
```
  - getT6
```
public int getT6()
```
  - getT7
```
public int getT7()
```
  - getT8
```
public int getT8()
```
  - init
```
public void init()
          throws BadParameterException
```
    Throws:
    
    BadParameterException
  - removeMessageHandler
```
public void removeMessageHandler(java.lang.Object messageHandler)
```
    Remove a message handler object.
    
    Specified by:
    
    removeMessageHandler in interface WrapperInterface
    
    Parameters:
    
    messageHandler - the message handler to add
    
    See Also:
    
    SecsMsg.processSelf(java.lang.Object)
  - secsEvent
```
public void secsEvent(SecsEvent theEvent)
```
    Catches incoming PORT_ERROR and SESSION_CREATED events and removes the portManager. This method can also be called by the MessageHandler code.
    
    Specified by:
    
    secsEvent in interface SecsEventListener
  - setActive
```
public void setActive(boolean flag)
```
    Determines whether newly created sessions should be set to the active session. NOTE: Default is true.
    
    Specified by:
    
    setActive in interface WrapperInterface
    
    Parameters:
    
    flag - true if created session should be made the active session.
    
    See Also:
    
    SessionManager#setActive
  - setDefault
```
public void setDefault(boolean flag)
```
    Determines whether newly created sessions should be set to the default session. NOTE: Default is true.
    
    Specified by:
    
    setDefault in interface WrapperInterface
    
    Parameters:
    
    flag - true if created session should be made the default session.
    
    See Also:
    
    SessionManager.setDefault()
  - setDefaultLinkTestInterval
```
public static void setDefaultLinkTestInterval(double defaultLinkTestInterval)
```
    Sets the default link test interval. This link test interval for any newly created object will be set to this.
  - setDeviceId
```
public void setDeviceId(int newValue)
```
    Sets the device id for this wrapper.
    
    Specified by:
    
    setDeviceId in interface WrapperInterface
    
    See Also:
    
    getDeviceId.
  - setLinkTestInterval
```
public void setLinkTestInterval(double linkTestInterval)
```
    This value controls how often LinkTest messages are sent. The value is in seconds. A value > 1 will cause LinkTest messages to be sent with that interval between message attempts.
    
    See Also:
    
    LinkTest
  - setLogger
```
public void setLogger(LoggerInterface theLogger)
```
    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
    
    Parameters:
    
    theLogger - the logger to add.
  - setPort
```
public void setPort(int port)
```
    Set the TCP/IP port to listen/connect on.
    
    Parameters:
    
    port - the TCP/IP port number
  - setPortManager
```
public void setPortManager(PortManager pm)
```
    Sets the port manager for the wrapper. May be null if there is no connection.
    
    Specified by:
    
    setPortManager in interface WrapperInterface
    
    Parameters:
    
    the - port manager.
  - setT3
```
public void setT3(double newValue)
```
    Description copied from interface: WrapperInterface
    
    Sets the reply timeout.
    
    Specified by:
    
    setT3 in interface WrapperInterface
  - setT5
```
public void setT5(int newValue)
```
  - setT6
```
public void setT6(int newValue)
```
  - setT7
```
public void setT7(int newValue)
```
  - setT8
```
public void setT8(int newValue)
```
  - start
```
public void start()
           throws BadParameterException,
                  VIBUpdateFailedException
```
    Throws:
    
    BadParameterException
    
    VIBUpdateFailedException
  - stop
```
public void stop()
          throws BadParameterException
```
    Throws:
    
    BadParameterException

Class HSMSWrapper

Field Summary

Fields inherited from interface com.ergotech.secs.WrapperInterface

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.ergotech.secs.WrapperInterface

Constructor Detail

HSMSWrapper

Method Detail

addMessageHandler

addMessageHandler

connect

destroy

disconnect

getDefaultLinkTestInterval

getDeviceId

getLinkTestInterval

getLogger

getMessageHandlers

getPort

getPortManager

getRawSessionManager

getSessionManager

getSessionManager

getT3

getT5

getT6

getT7

getT8

init

removeMessageHandler

secsEvent

setActive

setDefault

setDefaultLinkTestInterval

setDeviceId

setLinkTestInterval

setLogger

setPort

setPortManager

setT3

setT5

setT6

setT7

setT8

start

stop