SecsIConnectionManager (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.secs.ConnectionManager
- - com.ergotech.secs.SecsIConnectionManager

All Implemented Interfaces:

java.lang.Runnable
```
public class SecsIConnectionManager
extends ConnectionManager
implements java.lang.Runnable
```
There are two threads and a queue used by this object to acomplish its goals. There must always be a queue reading the port. Unlike HSMS, this has to occur while sending also to receive the protocol bytes (ENQ, EOT, etc.). This is set up as its own thread. In order to allow all this to happen, we have to create a queue and a thread to actually process the message.

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`ACK`
`static byte`	`ENQ`
`static byte`	`EOT`
`static byte`	`NAK`
`int`	`retryLimit` How many times to attempt a resend when a NAK is received.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`calcChecksum(byte[] msg, int offset, int length)` Calculate the checksum of length bytes from the given offset.
`void`	`closeConnection()` Close the connection and stop the input thread.
`boolean`	`getAllowDuplicateMessages()` If this flag is set then duplicate messages will be passed through as if they were not duplicate.
`java.lang.String`	`getId()` Returns an ID for this connection.
`boolean`	`getIsEquipment()` Returns whether this instance is the equipment or the host.
`SessionManager`	`getNewSessionManager()` Return a new SessionManager object by calling the getNewSessionManager method of SecsISessionManager.
`int`	`getRetryLimit()`
`double`	`getT1_IntercharacterTimeout()` Returns the Intercharacter Timeout as defined by the Semi SECSI specification.
`double`	`getT1()`
`double`	`getT2_ProtocolTimeout()` Returns the Protocol Timeout as defined by the Semi SECSI specification.
`double`	`getT2()`
`double`	`getT4_InterblockTimeout()` Returns the Interblock Timeout as defined by the Semi SECSI specification.
`double`	`getT4()`
`boolean`	`requiresPoll()` Returns true if we need to poll for messages.
`void`	`run()` Runs the port manager waiting for input on the socket that we were created for.
`void`	`sendMessage(byte[] msg)` send the message
`void`	`sendMessage(byte[][] msg)` Send a multi-block message.
`void`	`setAllowDuplicateMessages(boolean allowDuplicateMessages)` If this flag is set then duplicate messages will be passed through as if they were not duplicate.
`void`	`setIsEquipment(boolean flag)` Sets whether this instance is the equipment or the host.
`void`	`setRetryLimit(int newValue)`
`void`	`setT1_IntercharacterTimeout(double to)` Sets the Intercharacter Timeout as defined by the Semi SECSI specification.
`void`	`setT1(double newValue)`
`void`	`setT2_ProtocolTimeout(double to)` Sets the Protocol Timeout as defined by the Semi SECSI specification.
`void`	`setT2(double newValue)`
`void`	`setT4_InterblockTimeout(double to)` Sets the Interblock Timeout as defined by the Semi SECSI specification.
`void`	`setT4(double newValue)`

Methods inherited from class com.ergotech.secs.ConnectionManager
addSessionManager, addSessionManager, getActiveEntityFlag, getPortManager, getSessionManager, getSessionManagers, setActiveEntityFlag, setPortManager

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

- Field Detail
  - ACK
```
public static final byte ACK
```
    See Also:
    
    Constant Field Values
  - ENQ
```
public static final byte ENQ
```
    See Also:
    
    Constant Field Values
  - EOT
```
public static final byte EOT
```
    See Also:
    
    Constant Field Values
  - NAK
```
public static final byte NAK
```
    See Also:
    
    Constant Field Values
  - retryLimit
```
public int retryLimit
```
    How many times to attempt a resend when a NAK is received. Default is 1.
- Method Detail
  - calcChecksum
```
public int calcChecksum(byte[] msg,
                        int offset,
                        int length)
```
    Calculate the checksum of length bytes from the given offset.
  - closeConnection
```
public void closeConnection()
                     throws SecsException
```
    Close the connection and stop the input thread.
    
    Overrides:
    
    closeConnection in class ConnectionManager
    
    Throws:
    
    SecsException
  - getAllowDuplicateMessages
```
public boolean getAllowDuplicateMessages()
```
    If this flag is set then duplicate messages will be passed through as if they were not duplicate. This is for some old equipment that uses the same system bytes for all messages.
  - getId
```
public java.lang.String getId()
```
    Returns an ID for this connection. This is the hostname.
    
    Specified by:
    
    getId in class ConnectionManager
  - getIsEquipment
```
public boolean getIsEquipment()
```
    Returns whether this instance is the equipment or the host.
    
    Returns:
    
    isEquipment
  - getNewSessionManager
```
public SessionManager getNewSessionManager()
```
    Return a new SessionManager object by calling the getNewSessionManager method of SecsISessionManager.
    
    Specified by:
    
    getNewSessionManager in class ConnectionManager
    
    See Also:
    
    SessionManager.getNewSessionManager()
  - getRetryLimit
```
public int getRetryLimit()
```
  - getT1_IntercharacterTimeout
```
public double getT1_IntercharacterTimeout()
```
    Returns the Intercharacter Timeout as defined by the Semi SECSI specification.
    
    Returns:
    
    the t1_IntercharacterTimeout
  - getT1
```
public double getT1()
```
  - getT2_ProtocolTimeout
```
public double getT2_ProtocolTimeout()
```
    Returns the Protocol Timeout as defined by the Semi SECSI specification.
    
    Returns:
    
    the t2_ProtocolTimeout
  - getT2
```
public double getT2()
```
  - getT4_InterblockTimeout
```
public double getT4_InterblockTimeout()
```
    Returns the Interblock Timeout as defined by the Semi SECSI specification.
    
    Returns:
    
    the t4_InterblockTimeout
  - getT4
```
public double getT4()
```
  - requiresPoll
```
public boolean requiresPoll()
```
    Returns true if we need to poll for messages.
    
    Specified by:
    
    requiresPoll in class ConnectionManager
  - run
```
public void run()
```
    Runs the port manager waiting for input on the socket that we were created for.
    
    Specified by:
    
    run in interface java.lang.Runnable
  - sendMessage
```
public void sendMessage(byte[] msg)
                 throws java.io.IOException,
                        SecsException
```
    send the message
    
    Overrides:
    
    sendMessage in class ConnectionManager
    
    Throws:
    
    java.io.IOException
    
    SecsException
  - sendMessage
```
public void sendMessage(byte[][] msg)
                 throws java.io.IOException,
                        SecsException
```
    Send a multi-block message.
    
    Overrides:
    
    sendMessage in class ConnectionManager
    
    Throws:
    
    java.io.IOException
    
    SecsException
  - setAllowDuplicateMessages
```
public void setAllowDuplicateMessages(boolean allowDuplicateMessages)
```
    If this flag is set then duplicate messages will be passed through as if they were not duplicate. This is for some old equipment that uses the same system bytes for all messages.
  - setIsEquipment
```
public void setIsEquipment(boolean flag)
```
    Sets whether this instance is the equipment or the host.
    
    Parameters:
    
    flag - true if this instance is the equipment
  - setRetryLimit
```
public void setRetryLimit(int newValue)
```
  - setT1_IntercharacterTimeout
```
public void setT1_IntercharacterTimeout(double to)
```
    Sets the Intercharacter Timeout as defined by the Semi SECSI specification.
    
    Parameters:
    
    to - t1_IntercharacterTimeout
  - setT1
```
public void setT1(double newValue)
```
  - setT2_ProtocolTimeout
```
public void setT2_ProtocolTimeout(double to)
```
    Sets the Protocol Timeout as defined by the Semi SECSI specification.
    
    Parameters:
    
    to - t2_ProtocolTimeout
  - setT2
```
public void setT2(double newValue)
```
  - setT4_InterblockTimeout
```
public void setT4_InterblockTimeout(double to)
```
    Sets the Interblock Timeout as defined by the Semi SECSI specification.
    
    Parameters:
    
    to - t4_InterblockTimeout
  - setT4
```
public void setT4(double newValue)
```

Class SecsIConnectionManager

Field Summary

Method Summary

Methods inherited from class com.ergotech.secs.ConnectionManager

Methods inherited from class java.lang.Object

Field Detail

ACK

ENQ

EOT

NAK

retryLimit

Method Detail

calcChecksum

closeConnection

getAllowDuplicateMessages

getId

getIsEquipment

getNewSessionManager

getRetryLimit

getT1_IntercharacterTimeout

getT1

getT2_ProtocolTimeout

getT2

getT4_InterblockTimeout

getT4

requiresPoll

run

sendMessage

sendMessage

setAllowDuplicateMessages

setIsEquipment

setRetryLimit

setT1_IntercharacterTimeout

setT1

setT2_ProtocolTimeout

setT2

setT4_InterblockTimeout

setT4