com.ergotech.secs

Class SecsISessionManager

java.lang.Object

com.ergotech.secs.SessionManager

com.ergotech.secs.SecsISessionManager

All Implemented Interfaces:

SimulationListener

public class SecsISessionManager
extends SessionManager

This object provides the transport layer for SECS-I. The nature of the object is largely hidden from the upper levels of the SECS protocol. This object provides all the functionality to send and receive SECS messages over a SECS-I link, including SECS-I over Ethernet through a terminal server.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev
static boolean	sendInterleaved Set to true to allow sending of interleaved messages.

Fields inherited from class com.ergotech.secs.SessionManager

eventListeners, globalSimulation, logger, MULTI_THREADED, primaryThreads, responseThreads, sendErrorMessages, SINGLE_THREADED

Method Summary

Modifier and Type	Method and Description
byte[][]	convertToBytes(SecsMsg msg) Converts a SecsMsg into the raw byte stream.
SecsMsg	createMessage(byte[] unconverted) Creates a SecsMsg from the raw byte stream.
static int	getBlockNumber(byte[] unconv) Returns the block number from the byte stream provide.
int	getHeaderSize() Returns the headersize for HSMS messages.
int	getMaximumBlockSize() Returns the maximum block size.
static SessionManager	getNewSessionManager() Return a new session manager object.
static int	getSessionId(byte[] unconv) Returns the session ID from the byte stream provide.
static SessionManager	getSessionManager(int port, int deviceId, int sessionId, boolean shouldCreate) Returns the session for the given port host and string.
static SessionManager	getSessionManager(int port, java.lang.String connectionId, int deviceId, int sessionId, boolean shouldCreate, LoggerInterface theLogger) Returns the session for the given port host and string.
void	sendMessage(SecsMsg msg) Sends the SECS Message over the HSMS link.
void	setMaximumBlockSize(int blockSize) Sets the maximum block size.

Methods inherited from class com.ergotech.secs.SessionManager

addMessageHandler, addToConnection, breakConnection, createSessionManager, createSessionManager, createSessionManager, createSessionManager, endSession, getConnectionManager, getDefault, getDeviceId, getExpectsReply, getIsHost, getLogger, getMessageHandlers, getPortManager, getReplyTimeout, getSessionManager, getSessionManager, getThreadingModel, getWaitingMessages, isDefault, isSimulating, isSimulationFlag, isValid, isValidHostCommandMessage, removeMessageHandler, reprocessMessage, setDefault, setDefault, setDeviceId, setIsHost, setLogger, setMessageHandlers, setReplyTimeout, setSimulationFlag, setThreadingModel, setValid, simulationStateChanged, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

sendInterleaved

public static boolean sendInterleaved

Set to true to allow sending of interleaved messages. By default the driver will receive interleaved messages but not send them.

Method Detail

convertToBytes

public byte[][] convertToBytes(SecsMsg msg)
                        throws SecsException

Converts a SecsMsg into the raw byte stream. The return is a two dimensional array since the message may need to be broken into multiple blocks to be acceptable for some protocols.

Specified by:

convertToBytes in class SessionManager

Returns:

a two dimensional array containing the converted form of the SecsMsg. The array contains the message broken into different segments if necessary.

Throws:

SecsException

createMessage

public SecsMsg createMessage(byte[] unconverted)
                      throws SecsException

Creates a SecsMsg from the raw byte stream.

Specified by:

createMessage in class SessionManager

Returns:

A SecsMsg object containing the information contained in the bytestream.

Throws:

SecsException

See Also:

SecsMsg.getData()

getBlockNumber

public static int getBlockNumber(byte[] unconv)

Returns the block number from the byte stream provide.

Returns:

the block number

getHeaderSize

public int getHeaderSize()

Returns the headersize for HSMS messages.

Specified by:

getHeaderSize in class SessionManager

Returns:

10

getMaximumBlockSize

public int getMaximumBlockSize()

Returns the maximum block size. By default this is 254.

Returns:

the maximum block size.

getNewSessionManager

public static SessionManager getNewSessionManager()

Return a new session manager object. This method returns a new SecsISessionManager.

getSessionId

public static int getSessionId(byte[] unconv)

Returns the session ID from the byte stream provide.

Returns:

the session ID

getSessionManager

public static SessionManager getSessionManager(int port,
                                               int deviceId,
                                               int sessionId,
                                               boolean shouldCreate)
                                        throws SecsException

Returns the session for the given port host and string.

Parameters:

port - the port identifier. The socket port for HSMS and arbitrary designation for SECS1.

connectionId - the host name for HSMS, ignored for SECS1

deviceId - the device id

Throws:

SecsException

getSessionManager

public static SessionManager getSessionManager(int port,
                                               java.lang.String connectionId,
                                               int deviceId,
                                               int sessionId,
                                               boolean shouldCreate,
                                               LoggerInterface theLogger)
                                        throws SecsException

Returns the session for the given port host and string.

Parameters:

port - the port identifier. The socket port for HSMS and arbitrary designation for SECS1.

connectionId - the host name for HSMS, ignored for SECS1

deviceId - the device id

theLogger - the logger object

Throws:

SecsException

sendMessage

public void sendMessage(SecsMsg msg)
                 throws SecsException

Sends the SECS Message over the HSMS link.

Specified by:

sendMessage in class SessionManager

Throws:

SecsException

setMaximumBlockSize

public void setMaximumBlockSize(int blockSize)
                         throws java.lang.IllegalArgumentException

Sets the maximum block size.

Parameters:

blockSize - the new maximum block size.

Throws:

java.lang.IllegalArgumentException