OverView Index Help WebNMS Agent Toolkit C Edition 6

tl1chnlsecu.c

This file contains method definitions for adding,editing, deleting,retreiving channel security details.

Return Type	Method Summary
INT32	`ChannelSecuAuth(INT32 sessID)` Checks if channel is in service.
RtrvCidResBlock*	`CreateRtrvCidResponseBlock(CHAR * AID, CHAR * CHAP, INT32 MXINV, CHAR * DURAL, INT32 TMOUT)` This method creates response block the response block using the parameters as specified in the response block structure definition of the corresponding header file.
U_CHAR	`DltCidAction(InputCmdType incmd, Vector textBlockVector, INT32 sessID, U_CHAR errStatus, TL1Info tl1InfoPtr)` This method will be called by TL1 Engine upon receiving the input command.
U_CHAR	`EdCidAction(InputCmdType incmd, Vector textBlockVector, INT32 sessID, U_CHAR errStatus, TL1Info tl1InfoPtr)` This method will be called by TL1 Engine upon receiving the input command.
U_CHAR	`EntCidAction(InputCmdType incmd, Vector textBlockVector, INT32 sessID, U_CHAR errStatus, TL1Info tl1InfoPtr)` This method will be called by TL1 Engine upon recieving the input command.
INT32	`LockChannel(CHAR * chnlName)` Locks the channel.
U_CHAR	`RtrvCidAction(InputCmdType incmd, Vector textBlockVector, INT32 sessID, U_CHAR errStatus, TL1Info tl1InfoPtr)` This method will be called by TL1 Engine upon receiving the input command.
void	`UnlockChannel(void * chnlID)` Unlocks channel for use again.

Method Details

ChannelSecuAuth()

INT32 ChannelSecuAuth(INT32 sessID)

Checks if channel is in service.

Arguments:

1. SessionID

Return type:

SUCCESS/FAILURE

Bugs:

null

See Also:

CreateRtrvCidResponseBlock()

RtrvCidResBlock* CreateRtrvCidResponseBlock(CHAR * AID, CHAR * CHAP, INT32 MXINV, CHAR * DURAL, INT32 TMOUT)

This method creates response block the response block using the parameters as specified in the response block structure definition of the corresponding header file.

Arguments:

1. Response Block Parameter - AID(IN)

2. Response Block Parameter - CHAP(IN)

3. Response Block Parameter - MXINV(IN)

4. Response Block Parameter - DURAL(IN)

5. Response Block Parameter - TMOUT(IN)

Return type:

This function returns pointer to the created response block.

Bugs:

null

See Also:

DltCidAction()

U_CHAR DltCidAction(InputCmdType *incmd, Vector* textBlockVector,INT32 sessID,U_CHAR *errStatus,TL1Info *tl1InfoPtr)

This method will be called by TL1 Engine upon receiving 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.

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:

EdCidAction()

U_CHAR EdCidAction(InputCmdType *incmd, Vector* textBlockVector,INT32 sessID,U_CHAR *errStatus,TL1Info *tl1InfoPtr)

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:

EntCidAction()

U_CHAR EntCidAction(InputCmdType *incmd, Vector* textBlockVector,INT32 sessID,U_CHAR *errStatus,TL1Info *tl1InfoPtr)

This method will be called by TL1 Engine upon recieving the input command. This function initializes the AID and message payload structure variables using the received input message AID and message payload block parameters.

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:

LockChannel()

INT32 LockChannel(CHAR * chnlName)

Locks the channel.

Arguments:

1. Channel name

Return type:

SUCCESS/FAILURE

Bugs:

null

See Also:

RtrvCidAction()

U_CHAR RtrvCidAction(InputCmdType *incmd, Vector* textBlockVector,INT32 sessID,U_CHAR *errStatus,TL1Info *tl1InfoPtr)

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:

UnlockChannel()

void UnlockChannel(void * chnlID)

Unlocks channel for use again.

Arguments:

1. Channel key.

Return type:

Nothing.

Bugs:

null

See Also:

OverView Index Help WebNMS Agent Toolkit C Edition 6