OverView Index Help                                                                WebNMS Agent Toolkit C Edition 6 
eocrehdlr.c.
This file contains the methods for adding,editing,deleting, retreiving EOC data.
Return Type Method Summary
EOCRoutingEntry* CreateNewEOCEntry(CHAR * routID, CHAR *activeEOC, CHAR *backupEOC, U_INT32 ocId, INT32 lapdAddr)
             Creates new EOC Routing Entry.
U_CHAR DltEocreAck(InputCmdType *incmd, INT32 sessionID)
             This method is called from when the agent does not send a response message within a specified time.
U_CHAR DltEocreAction(InputCmdType *incmd, Vector* textBlockVector, INT32 sessionID, U_CHAR *errStatus, TL1Info *tl1InfoPtr)
             This method will be called by TL1 Engine upon receiving the the input command.
U_CHAR EdEocreAck(InputCmdType *incmd, INT32 sessionID)
             This method is called from when the agent does not send a response message within a specified time.
U_CHAR EdEocreAction(InputCmdType *incmd, Vector* textBlockVector, INT32 sessionID, U_CHAR *errStatus, TL1Info *tl1InfoPtr)
             This method will be called by TL1 Engine upon receiving the the input command.
U_CHAR EdOcaAck(InputCmdType *incmd, INT32 sessionID)
             This method is called from when the agent does not send a response message within a specified time.
U_CHAR EdOcaAction(InputCmdType *incmd, Vector* textBlockVector, INT32 sessionID, U_CHAR *errStatus, TL1Info *tl1InfoPtr)
             This method will be called by TL1 Engine upon receiving the the input command.
U_CHAR EntEocreAck(InputCmdType *incmd, INT32 sessionID)
             This method is called from when the agent does not send a response message within a specified time.
U_CHAR EntEocreAction(InputCmdType *incmd, Vector* textBlockVector, INT32 sessionID, U_CHAR *errStatus, TL1Info *tl1InfoPtr)
             This method will be called by TL1 Engine upon receiving the the input command.
void FreeEOCRoutingEntry(EOCRoutingEntry *entryPtr)
             Frees new EOC Routing Entry.
void FreeRtrvEocreResponseBlock(void *resPtr, U_CHAR fType)
             Frees response block variable .
CHAR InitDltEocre()
             This method is called from gatewayne.
CHAR InitEdEocre()
             This method is called from gatewayne.
CHAR InitEdOca()
             This method is called from gatewayne.
CHAR InitEntEocre()
             This method is called from gatewayne.
CHAR InitRtrvEocre()
             This method is called from gatewayne.
U_CHAR RtrvEocreAck(InputCmdType *incmd, INT32 sessionID)
             This method is called from when the agent does not send a response message within a specified time.
U_CHAR RtrvEocreAction(InputCmdType *incmd, Vector* textBlockVector, INT32 sessionID, U_CHAR *errStatus, TL1Info *tl1InfoPtr)
             This method will be called by TL1 Engine upon receiving the the input command.
   
Method Details

CreateNewEOCEntry()

EOCRoutingEntry* CreateNewEOCEntry(CHAR * routID,CHAR *activeEOC,CHAR *backupEOC,U_INT32 ocId,INT32 lapdAddr)

Creates new EOC Routing Entry.

Arguments:
1. Routing Identifier
2. Active EOC
3. Backup EOC
4. OC Identifer
5. LAPD Address
Return type:
Reference to EOCRoutingEntry or NULL.
Bugs:
null
See Also:

DltEocreAck()

U_CHAR DltEocreAck(InputCmdType *incmd,INT32 sessionID)

This method is called from when the agent does not send a response message within a specified time.(i.e) If a normal response or an error response cannot be sent within 2 seconds of receipt of receiving the input command an appropriate acknowledgment should be sent.

Arguments:
Nothing.
Return type:
This method returns any one of the following types IN_PROGRESS or PRINTOUT_FOLLOWS ,NO_ACK, REPEAT_LATER, ALL_RIGHT.
Bugs:
null
See Also:

DltEocreAction()

U_CHAR DltEocreAction(InputCmdType *incmd, Vector* textBlockVector,INT32 sessionID,U_CHAR *errStatus,TL1Info *tl1InfoPtr)

This method will be called by TL1 Engine upon receiving the the input command.Here, user can writehis code to perform the necessary action upon receiving the input command. This function initializes the AID and message payload structure variables using the received input message AID and message payload block parameters. The AID structure, message pay load structure and output text block structure are generated in the corresponding header file according to the syntax defined in TCS file.

Arguments:
1. Reference to the received input command(IN)
2. Reference to text block vector(OUT)
3. Error status
Return type:
This method returns any one of the following command completion code: COMPLD, DENY, PRTL, DELAY and RTRV.
Bugs:
null
See Also:

EdEocreAck()

U_CHAR EdEocreAck(InputCmdType *incmd,INT32 sessionID)

This method is called from when the agent does not send a response message within a specified time.(i.e) If a normal response or an error response cannot be sent within 2 seconds of receipt of receiving the input command an appropriate acknowledgment should be sent.

Arguments:
Nothing.
Return type:
This method returns any one of the following types IN_PROGRESS or PRINTOUT_FOLLOWS ,NO_ACK, REPEAT_LATER, ALL_RIGHT.
Bugs:
null
See Also:

EdEocreAction()

U_CHAR EdEocreAction(InputCmdType *incmd, Vector* textBlockVector,INT32 sessionID,U_CHAR *errStatus,TL1Info *tl1InfoPtr)

This method will be called by TL1 Engine upon receiving the the input command.Here, user can writehis code to perform the necessary action upon receiving the input command. This function initializes the AID and message payload structure variables using the received input message AID and message payload block parameters. The AID structure, message pay load structure and output text block structure are generated in the corresponding header file according to the syntax defined in TCS file.

Arguments:
1. Reference to the received input command(IN)
2. Reference to text block vector(OUT)
3. Error status
Return type:
This method returns any one of the following command completion code: COMPLD, DENY, PRTL, DELAY and RTRV.
Bugs:
null
See Also:

EdOcaAck()

U_CHAR EdOcaAck(InputCmdType *incmd,INT32 sessionID)

This method is called from when the agent does not send a response message within a specified time.(i.e) If a normal response or an error response cannot be sent within 2 seconds of receipt of receiving the input command an appropriate acknowledgment should be sent.

Arguments:
Nothing.
Return type:
This method returns any one of the following types IN_PROGRESS or PRINTOUT_FOLLOWS ,NO_ACK, REPEAT_LATER, ALL_RIGHT.
Bugs:
null
See Also:

EdOcaAction()

U_CHAR EdOcaAction(InputCmdType *incmd, Vector* textBlockVector,INT32 sessionID,U_CHAR *errStatus,TL1Info *tl1InfoPtr)

This method will be called by TL1 Engine upon receiving the the input command.Here, user can writehis code to perform the necessary action upon receiving the input command. This function initializes the AID and message payload structure variables using the received input message AID and message payload block parameters. The AID structure, message pay load structure and output text block structure are generated in the corresponding header file according to the syntax defined in TCS file.

Arguments:
1. Reference to the received input command(IN)
2. Reference to text block vector(OUT)
3. Error status
Return type:
This method returns any one of the following command completion code: COMPLD, DENY, PRTL, DELAY and RTRV.
Bugs:
null
See Also:

EntEocreAck()

U_CHAR EntEocreAck(InputCmdType *incmd,INT32 sessionID)

This method is called from when the agent does not send a response message within a specified time.(i.e) If a normal response or an error response cannot be sent within 2 seconds of receipt of receiving the input command an appropriate acknowledgment should be sent.

Arguments:
Nothing.
Return type:
This method returns any one of the following types IN_PROGRESS or PRINTOUT_FOLLOWS ,NO_ACK, REPEAT_LATER, ALL_RIGHT.
Bugs:
null
See Also:

EntEocreAction()

U_CHAR EntEocreAction(InputCmdType *incmd, Vector* textBlockVector,INT32 sessionID,U_CHAR *errStatus,TL1Info *tl1InfoPtr)

This method will be called by TL1 Engine upon receiving the the input command.Here, user can writehis code to perform the necessary action upon receiving the input command. This function initializes the AID and message payload structure variables using the received input message AID and message payload block parameters. The AID structure, message pay load structure and output text block structure are generated in the corresponding header file according to the syntax defined in TCS file.

Arguments:
1. Reference to the received input command(IN)
2. Reference to text block vector(OUT)
3. Error status
Return type:
This method returns any one of the following command completion code: COMPLD, DENY, PRTL, DELAY and RTRV.
Bugs:
null
See Also:

FreeEOCRoutingEntry()

void FreeEOCRoutingEntry(EOCRoutingEntry *entryPtr)

Frees new EOC Routing Entry.

Arguments:
1.Reference to EOCRoutingEntry
Return type:
Nothing
Bugs:
null
See Also:

FreeRtrvEocreResponseBlock()

void FreeRtrvEocreResponseBlock(void *resPtr,U_CHAR fType)

Frees response block variable .

Arguments:
1. Reference to ResponseBlock(IN)
: 2. Format type(IN)
Return type:
Nothing
Bugs:
null
See Also:

InitDltEocre()

CHAR InitDltEocre(void)

This method is called from gatewayne.c at agent startup. It registers its action method and acknowledgement method with TL1 Engine.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing.
Return type:
SUCCESS/FAILURE.
Bugs:
null
See Also:

InitEdEocre()

CHAR InitEdEocre(void)

This method is called from gatewayne.c at agent startup. It registers its action method and acknowledgement method with TL1 Engine.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing.
Return type:
SUCCESS/FAILURE.
Bugs:
null
See Also:

InitEdOca()

CHAR InitEdOca(void)

This method is called from gatewayne.c at agent startup. It registers its action method and acknowledgement method with TL1 Engine.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing.
Return type:
SUCCESS/FAILURE.
Bugs:
null
See Also:

InitEntEocre()

CHAR InitEntEocre(void)

This method is called from gatewayne.c at agent startup. It registers its action method and acknowledgement method with TL1 Engine.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing.
Return type:
SUCCESS/FAILURE.
Bugs:
null
See Also:

InitRtrvEocre()

CHAR InitRtrvEocre(void)

This method is called from gatewayne.c at agent startup. It registers its action method and acknowledgement method with TL1 Engine.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing.
Return type:
SUCCESS/FAILURE.
Bugs:
null
See Also:

RtrvEocreAck()

U_CHAR RtrvEocreAck(InputCmdType *incmd,INT32 sessionID)

This method is called from when the agent does not send a response message within a specified time.(i.e) If a normal response or an error response cannot be sent within 2 seconds of receipt of receiving the input command an appropriate acknowledgment should be sent.

Arguments:
Nothing.
Return type:
This method returns any one of the following types IN_PROGRESS or PRINTOUT_FOLLOWS ,NO_ACK, REPEAT_LATER, ALL_RIGHT.
Bugs:
null
See Also:

RtrvEocreAction()

U_CHAR RtrvEocreAction(InputCmdType *incmd, Vector* textBlockVector,INT32 sessionID,U_CHAR *errStatus,TL1Info *tl1InfoPtr)

This method will be called by TL1 Engine upon receiving the the input command.Here, user can writehis code to perform the necessary action upon receiving the input command. This function initializes the AID and message payload structure variables using the received input message AID and message payload block parameters. The AID structure, message pay load structure and output text block structure are generated in the corresponding header file according to the syntax defined in TCS file.

Arguments:
1. Reference to the received input command(IN)
2. Reference to text block vector(OUT)
3. Error status
Return type:
This method returns any one of the following command completion code: COMPLD, DENY, PRTL, DELAY and RTRV.
Bugs:
null
See Also:
OverView Index Help                                                                WebNMS Agent Toolkit C Edition 6 
Copyright (c) 2009 ZOHO Corp. All Rights Reserved.