HSMSActiveWrapper (ErgoTech VIB/TransSECS Scripting API)

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

All Implemented Interfaces:

SecsEventListener, WrapperInterface, java.io.Serializable, java.lang.Runnable, java.util.EventListener
```
public class HSMSActiveWrapper
extends HSMSWrapper
implements java.lang.Runnable
```
See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description
`HSMSActiveWrapper(int port, int deviceId, java.lang.String hostName)` Create the passive wrapper for the particular TCP/IP port.

Method Summary

All Methods Static 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.
`void`	`disconnect()` Disconnect the connection.
`static double`	`getDefaultRetryInterval()` Sets the default retry interval.
`java.lang.String`	`getHostName()`
`double`	`getRetryInterval()` The time, in seconds, between attempts to establish a connection.
`boolean`	`initializeConnection()` Create the connection to the equipment.
`void`	`removeMessageHandler(java.lang.Object messageHandler)` Remove a message handler object.
`void`	`run()` Run waiting for a connection to be established.
`void`	`secsEvent(SecsEvent theEvent)` Catches incoming PORT_ERROR and re-starts the connection thread if it has been configured.
`static void`	`setDefaultRetryInterval(double defaultRetryInterval)` Sets the default retry interval.
`void`	`setRetryInterval(double retryInterval)` The time, in seconds, between attempts to establish a connection.
`void`	`stopConnectionThread()` This will stop the connection thread.
`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, getSessionManager, getT3, getT5, getT6, getT7, getT8, init, setActive, setDefault, setDefaultLinkTestInterval, setDeviceId, setLinkTestInterval, setLogger, 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
  - HSMSActiveWrapper
```
public HSMSActiveWrapper(int port,
                         int deviceId,
                         java.lang.String hostName)
```
    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.
    
    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
  - 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. Note that this will not start attempting to reconnect and you must call connect again to restart that process.
    
    Specified by:
    
    disconnect in interface WrapperInterface
    
    Overrides:
    
    disconnect in class HSMSWrapper
    
    See Also:
    
    connect()
  - getDefaultRetryInterval
```
public static double getDefaultRetryInterval()
```
    Sets the default retry interval. This retry interval for any newly created object will be set to this.
  - getHostName
```
public java.lang.String getHostName()
```
  - getRetryInterval
```
public double getRetryInterval()
```
    The time, in seconds, between attempts to establish a connection. If this value is non-zero the wrapper will repeatedly attempt to establish a connection waiting this amount of time between attempts. If the value is less than zero then no automatic attempts are made to establish the connection. The default value is -1 so not automatic attempts are made. A value of zero will cause the thread to run as fast as possible, consuming as much CPU time as possible so should be used with care and only on systems where no processing occurs while the wrapper is closed. This value should not normally be less than the T5 of the target.
  - initializeConnection
```
public boolean initializeConnection()
                             throws SecsException
```
    Create the connection to the equipment.
    
    Specified by:
    
    initializeConnection in interface WrapperInterface
    
    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)
  - run
```
public void run()
```
    Run waiting for a connection to be established. This thread will run until a connection is established and then exit. It will restart if the connection is dropped and the SecsEvent PORT_ERROR is detected.
    
    Specified by:
    
    run in interface java.lang.Runnable
  - secsEvent
```
public void secsEvent(SecsEvent theEvent)
```
    Catches incoming PORT_ERROR and re-starts the connection thread if it has been configured.
    
    Specified by:
    
    secsEvent in interface SecsEventListener
    
    Overrides:
    
    secsEvent in class HSMSWrapper
  - setDefaultRetryInterval
```
public static void setDefaultRetryInterval(double defaultRetryInterval)
```
    Sets the default retry interval. This retry interval for any newly created object will be set to this.
  - setRetryInterval
```
public void setRetryInterval(double retryInterval)
```
    The time, in seconds, between attempts to establish a connection. If this value is non-zero the wrapper will repeatedly attempt to establish a connection waiting this amount of time between attempts. If the value is less than zero then no automatic attempts are made to establish the connection. The default value is -1 so not automatic attempts are made. A value of zero will cause the thread to run as fast as possible, consuming as much CPU time as possible so should be used with care and only on systems where no processing occurs while the wrapper is closed. This value should not normally be less than the T5 of the target. If the retryInterval is >= 0 then this method will also initialize the connection to begin connection attempts.
  - stopConnectionThread
```
public void stopConnectionThread()
```
    This will stop the connection thread.
    
    See Also:
    
    connect()
  - toString
```
public java.lang.String toString()
```
    Returns an description of this object.
    
    Overrides:
    
    toString in class java.lang.Object

Class HSMSActiveWrapper

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

HSMSActiveWrapper

Method Detail

addMessageHandler

addMessageHandler

connect

disconnect

getDefaultRetryInterval

getHostName

getRetryInterval

initializeConnection

removeMessageHandler

run

secsEvent

setDefaultRetryInterval

setRetryInterval

stopConnectionThread

toString