tcsCON_SUB_SYSTEM.4

Manpage of tcsCON_SUB_SYSTEM

tcsCON_SUB_SYSTEM

Section: Devices and Network Interfaces (4)
Updated: 2012-04-23 10:08
Index Return to man pages list

NAME

tcsCON_SUB_SYSTEM - host class for transfer command objects

SYNOPSIS


#include <tcsCON_SUB_SYSTEM.h>
tcsCON_SUB_SYSTEM tcsConLCU(dbRoot);

PARENT CLASS


tcsSTATE

DESCRIPTION


This class serves as host for transfer command objects. It reads a
table from the database where the names and timeouts of all transfer
commands are configured. For each entry it creates an appropriate
tcsTRANSFER object and stores it in an internal object list.

PUBLIC METHODS


tcsCON_SUB_SYSTEM(const dbSYMADDRESS dbRoot);
  The constructor creates the handlers for all transfer commands. It
  takes the module database root point as argument.

~tcsCON_SUB_SYSTEM();
  See Clear().

ccsCOMPL_STAT Init();
  Reads transfer command configuration table from database and creates
  the transfer command objects.
  It configures also the listCommand vector for sending commands to all
  m2Server processes.
const char *LcuEnvName();
  Returns the name of the Lcu environment
vltINT32 Timeout();
  Returns a common timeout for commands.

 const char *LcuServer();
  Returns the name of the according server process.
 ccsCOMPL_STAT Stop(tcsCMD_HANDLER *handler);
 ccsCOMPL_STAT Stop(fndOBJECT    *obj,
                    evhCB_METHOD  reply,
                    evhCB_METHOD  errReply,
                    evhCB_METHOD  timeout = NULL,
                    void         *udata   = NULL);
  Sends STOP to LCU subsystem
  if handler != NULL it is used to send back the replies from the LCU
  there is only ONE error, normal tor timeout reply sent back.

PROTECTED METHODS


evhCB_COMPL_STAT StopReplyCB(msgMESSAGE &msg, void *);
evhCB_COMPL_STAT StopErrorCB(msgMESSAGE &msg, void *);
evhCB_COMPL_STAT StopTimeoutCB(msgMESSAGE &msg, void *);
ccsCOMPL_STAT SetLcuTargetList();
  initalizes table for list commands.

void Clear();
  Deletes all hosted transfer command objects and frees the internal
  object list.

PRIVATE DATA MEMBERS


dbSYMADDRESS    dbPoint; // DB TRANSFER point
vltINT32        objCount; // number of hosted transfer command objects
tcsTRANSFER **objList;  // array of pointers to hosted transfer objects
ccsENVNAME      lcuEnvName;
ccsPROCNAME     lcuServer;
vltINT32        timeout;
evhDB_LIST_COMMAND *stopCommand;
tcsCMD_HANDLER     *stopHandler;

This document was created by man2html, using the manual pages.
Time: 10:08:47 GMT, April 23, 2012

VLT Software Documentation