ConnectionManager (ErgoTech VIB/TransSECS Scripting API)

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

Direct Known Subclasses:

HSMSConnectionManager, SecsIConnectionManager
```
public abstract class ConnectionManager
extends java.lang.Object
```
The connection manager object is the superclass of the specific connection managers. It provides a consistent interface to the connection manager and isolates the SECS implementation from the transport layer, for example SECS1 or HSMS.

Constructor Summary

Constructors
Constructor and Description

ConnectionManager()
Handles Simulation Modes.

Constructors
Constructor and Description
`ConnectionManager()` Handles Simulation Modes.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSessionManager(SessionManager sm)` Add a session manager.
`void`	`addSessionManager(SessionManager sm, int deviceId)` Add a session manager.
`void`	`closeConnection()` Terminate the connection.
`boolean`	`getActiveEntityFlag()` Returns true if we are the active entity or host, otherwise false.
`abstract java.lang.String`	`getId()` Returns an ID for this connection.
`abstract SessionManager`	`getNewSessionManager()` Return a new session manager object.
`PortManager`	`getPortManager()` returns the port manager
`SessionManager`	`getSessionManager(int sessionId)` This will return the SessionManager object for a specific sessionId or it will return the general session SessionManager if on exists.
`java.util.Hashtable<java.lang.Integer,SessionManager>`	`getSessionManagers()` This will return the all the session managers.
`abstract boolean`	`requiresPoll()` Returns true if we need to poll for messages.
`void`	`sendMessage(byte[] msg)` Send data out through the connection.
`void`	`sendMessage(byte[][] msg)` Send multi-block data out through the connection.
`void`	`setActiveEntityFlag(boolean flag)` Controls whether we are the active entity.
`void`	`setPortManager(PortManager newValue)` sets the port manager

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

- Constructor Detail
  - ConnectionManager
```
public ConnectionManager()
```
    Handles Simulation Modes.
- Method Detail
  - addSessionManager
```
public void addSessionManager(SessionManager sm)
```
    Add a session manager. This will become the session manager for the session id it is managing.
    
    Parameters:
    
    sm -
  - addSessionManager
```
public void addSessionManager(SessionManager sm,
                              int deviceId)
```
    Add a session manager. This will become the session manager for the session id it is managing.
    
    Parameters:
    
    sm -
  - closeConnection
```
public void closeConnection()
                     throws SecsException
```
    Terminate the connection. This could be called by the user or after a socket read error.
    
    Throws:
    
    SecsException
  - getActiveEntityFlag
```
public boolean getActiveEntityFlag()
```
    Returns true if we are the active entity or host, otherwise false.
    
    Returns:
    
    true if we are the active entity or host.
  - getId
```
public abstract java.lang.String getId()
```
    Returns an ID for this connection. This is the hostname.
  - getNewSessionManager
```
public abstract SessionManager getNewSessionManager()
```
    Return a new session manager object. The class of the session manager is determined by the subclass.
    
    See Also:
    
    SessionManager.getNewSessionManager()
  - getPortManager
```
public PortManager getPortManager()
```
    returns the port manager
  - getSessionManager
```
public SessionManager getSessionManager(int sessionId)
```
    This will return the SessionManager object for a specific sessionId or it will return the general session SessionManager if on exists. WARNING: This may return null if one hasn't been created yet.
  - getSessionManagers
```
public java.util.Hashtable<java.lang.Integer,SessionManager> getSessionManagers()
```
    This will return the all the session managers.
  - requiresPoll
```
public abstract boolean requiresPoll()
```
    Returns true if we need to poll for messages. We usually want to poll when we are on the message receive thread (the message handler thread).
  - sendMessage
```
public void sendMessage(byte[] msg)
                 throws java.io.IOException,
                        SecsException
```
    Send data out through the connection.
    
    Throws:
    
    java.io.IOException
    
    SecsException
  - sendMessage
```
public void sendMessage(byte[][] msg)
                 throws java.io.IOException,
                        SecsException
```
    Send multi-block data out through the connection.
    
    Throws:
    
    java.io.IOException
    
    SecsException
  - setActiveEntityFlag
```
public void setActiveEntityFlag(boolean flag)
```
    Controls whether we are the active entity. If the flag is "true" then this connection will be considered to be the host, or the entity creating the connection. If false, then we will be considered to be the equipment or passive entity. This method is only useful externally in SECSI since HSMS knows by the method of creation what mode it is in and will set the value correctly internally.
    
    Parameters:
    
    flag - true if we are the active entity or host.
  - setPortManager
```
public void setPortManager(PortManager newValue)
```
    sets the port manager

Class ConnectionManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConnectionManager

Method Detail

addSessionManager

addSessionManager

closeConnection

getActiveEntityFlag

getId

getNewSessionManager

getPortManager

getSessionManager

getSessionManagers

requiresPoll

sendMessage

sendMessage

setActiveEntityFlag

setPortManager