tifCOMMAND Class Reference

See man page tifCOMMAND(4)

More...

#include <tifInternal.h>

List of all members.

Public Member Functions
	tifCOMMAND (msgMESSAGE &cmd, tifROUTING *route)
	~tifCOMMAND ()
evhCB_COMPL_STAT	HandleReply (msgMESSAGE &reply, tifROUTING *route)
evhCB_COMPL_STAT	HandleErrorReply (msgMESSAGE &reply, tifROUTING *route)
evhCB_COMPL_STAT	HandleTimeout (msgMESSAGE &reply, tifROUTING *route)
Private Attributes
msgMESSAGE	userCommand

---

Detailed Description

See man page tifCOMMAND(4)

tifCOMMAND

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

---

 

NAME

tifCOMMAND - definition of the tifCOMMAND class

 

SYNOPSIS

tifCOMMAND(msgMESSAGE &cmd, tifROUTING &route);

 

PARENT CLASS

evhCOMMAND

 

DESCRIPTION

A tifCOMMAND object is created by the tif command router whenever an
user is received. The user command is passed to the tif constructor
which constructs a TCS command from it, sends it the appropriate TCS
module ( as specified in the routing table) and handles also the
reply/error reply/timeout by sending them to the user as reply to the
original command.

 

PUBLIC METHODS

tifCOMMAND       - constructor
~tifCOMMAND      - destructor
HandleReply      - handles normal reply/replies from the TCS module
HandleErrorReply - handles an error reply from the TCS module
HandleTimeout    - handles a timeout to the TCS command

 

PUBLIC DATA MEMBERS

None

 

PROTECTED METHODS

None

 

PROTECTED DATA MEMBERS

None

 

PRIVATE METHODS

None

 

PRIVATE DATA MEMBERS

msgMESSAGE userCommand
    original command received from user

 

ENVIRONMENT

TCS_ENVNAME specifies the environment in which TCS runs
TCS_DBPOINT specifies the root point of the TCS database branch

 

COMMANDS

All which are specified in the tif routing table.

 

RETURN VALUES

evhCB_XXX - bitmapped values, see evh user manual

 

SEE ALSO

evhCOMMAND

---

 

Index

NAME

SYNOPSIS

PARENT CLASS

DESCRIPTION

PUBLIC METHODS

PUBLIC DATA MEMBERS

PROTECTED METHODS

PROTECTED DATA MEMBERS

PRIVATE METHODS

PRIVATE DATA MEMBERS

ENVIRONMENT

COMMANDS

RETURN VALUES

SEE ALSO

---

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

Definition at line 94 of file tifInternal.h.

---

Constructor & Destructor Documentation

tifCOMMAND::tifCOMMAND	(	msgMESSAGE &	cmd,
		tifROUTING *	route
	)

Definition at line 102 of file tifCOMMAND.C.

References tifROUTING::env, HandleErrorReply(), HandleReply(), HandleTimeout(), tifROUTING::newCommand, tifROUTING::process, tifCmdsInProgress, tifERR_COMMAND, tifERR_OBJECT, tifMOD, tifROUTING::timeout, and userCommand.

tifCOMMAND::~tifCOMMAND

(

)

Definition at line 182 of file tifCOMMAND.C.

---

Member Function Documentation

evhCB_COMPL_STAT tifCOMMAND::HandleErrorReply	(	msgMESSAGE &	reply,
		tifROUTING *	route
	)

Definition at line 239 of file tifCOMMAND.C.

References tifCmdsInProgress, tifERR_COMMAND, tifERR_OBJECT, tifMOD, and userCommand.

Referenced by tifCOMMAND().

evhCB_COMPL_STAT tifCOMMAND::HandleReply	(	msgMESSAGE &	reply,
		tifROUTING *	route
	)

Definition at line 189 of file tifCOMMAND.C.

References tifCmdsInProgress, tifERR_COMMAND, tifERR_OBJECT, tifMOD, and userCommand.

Referenced by tifCOMMAND().

evhCB_COMPL_STAT tifCOMMAND::HandleTimeout	(	msgMESSAGE &	reply,
		tifROUTING *	route
	)

Definition at line 277 of file tifCOMMAND.C.

References tifROUTING::env, tifROUTING::process, tifCmdsInProgress, tifERR_COMMAND, tifERR_OBJECT, tifERR_TIMEOUT, tifMOD, tifROUTING::timeout, and userCommand.

Referenced by tifCOMMAND().

---

Member Data Documentation

msgMESSAGE tifCOMMAND::userCommand [private]

Definition at line 103 of file tifInternal.h.

Referenced by HandleErrorReply(), HandleReply(), HandleTimeout(), and tifCOMMAND().

---

The documentation for this class was generated from the following files:

• tifInternal.h
• tifCOMMAND.C