OverView Index Help                                                                WebNMS Agent Toolkit C Edition 6 
tl1commandsecuritytablehdlr.c.
To handle the requests from the manager for the module tl1commandsecuritytable.

See Also :
Return Type Method Summary
CHAR AddTl1CommandSecurityEntry(U_CHAR *command, INT32 cmdstatus, U_CHAR *cap, INT32 cmdrowStatus)
             It will take all columns value and its instance value as input and add create an entry then add it to the vector.
CHAR CreateAndAddNewTl1CommandSecurityTableEntry(U_CHAR *command, INT32 cmdstatus, U_CHAR *cap, INT32 cmdrowStatus)
             It will take all columns value as input and create an instance then add it to the vector.
CHAR CreateAndAddTl1CommandSecurityTableEntry(OID *instance, INT32 instanceLen, U_CHAR *command, INT32 cmdstatus, U_CHAR *cap, INT32 cmdrowStatus)
             It will take all columns value and its instance value as input and add create an entry then add it to the vector.
OID* CreateTl1CommandSecurityTableInstance(INT32 *instanceLen, U_CHAR *command)
             This method is called from the method CreateAndAddNewTl1CommandSecurityTableTableEntry().
void* CreateTl1CommandSecurityTableRowWithDefaultValues(U_CHAR **indexList, INT32 *indexListLen, INT32 len)
             It will create a new row and assign default value for each table column.
void FreeTl1CommandSecurityTableEntryMemory(Entry *entryPtr)
             This method is called from FreeTl1CommandSecurityTableVector().
void FreeTl1CommandSecurityTableVector()
             Free the gv_tl1CommandSecurityTableVector.
U_CHAR* GetCap(void *tableEntryPtr, INT32 *varValLen, U_CHAR *status)
             Get method for (table) column cap.
U_CHAR* GetCmdrowStatus(void *tableEntryPtr, INT32 *varValLen, U_CHAR *status)
             Get method for (table) column cmdrowStatus.
U_CHAR* GetCmdstatus(void *tableEntryPtr, INT32 *varValLen, U_CHAR *status)
             Get method for (table) column cmdstatus.
U_CHAR* GetCommand(void *tableEntryPtr, INT32 *varValLen, U_CHAR *status)
             Get method for (table) column command.
U_CHAR GetTl1CommandSecurityTableEntry(U_CHAR ***cols, INT32 index)
             It will get an entry from table.
Vector* GetTl1CommandSecurityTableInfo(INT32 startIdx, INT32 numOfRows, INT32 *flag)
             It will return the table vector reference, before that it will verify the total size of the table and set flag value.
void InitTl1CommandSecurityTable()
             It will register the treeCell with agent and initialize all data structures related to the module "tl1CommandSecurityTable".
U_CHAR* SetCap(void *tableEntryPtr, U_CHAR *varVal, INT32 *varValLen, U_CHAR *status)
             Set method for (table) column cap.
U_CHAR* SetCmdrowStatus(void *tableEntryPtr, U_CHAR *varVal, INT32 *varValLen, U_CHAR *status)
             Set method for (table) column cmdrowStatus.
U_CHAR* SetCmdstatus(void *tableEntryPtr, U_CHAR *varVal, INT32 *varValLen, U_CHAR *status)
             Set method for (table) column cmdstatus.
U_CHAR* SetCommand(void *tableEntryPtr, U_CHAR *varVal, INT32 *varValLen, U_CHAR *status)
             Set method for (table) column command.
CHAR Tl1CommandSecurityTableProcessRequests(U_CHAR protoType, U_CHAR cmdType, Vector *attrbsVect, INT32 numOfRows)
             This method will be called from the agent api for all the requests (GET/GET-NEXT/SET) with received pduType and varBind vector before processing the received varbinds.
CHAR UpdateTl1CommandSecurityTable(U_CHAR command)
             This method will be called from the agent api after successful SET/GET/GET-NEXT operation, in order to update the original or user application's data structrue with the changes made to Tl1CommandSecurityTable.
   
Method Details

AddTl1CommandSecurityEntry()

CHAR AddTl1CommandSecurityEntry(U_CHAR *command, INT32 cmdstatus, U_CHAR *cap, INT32 cmdrowStatus)

It will take all columns value and its instance value as input and add create an entry then add it to the vector.

Arguments:
1. Table column command (IN).
2. Table column cmdstatus (IN).
3. Table column cap (IN).
4. Table column cmdrowStatus (IN).
Return type:
SUCCESS or FAILURE.
Bugs:
null

CreateAndAddNewTl1CommandSecurityTableEntry()

CHAR CreateAndAddNewTl1CommandSecurityTableEntry(U_CHAR *command, INT32 cmdstatus, U_CHAR *cap, INT32 cmdrowStatus)

It will take all columns value as input and create an instance then add it to the vector.

Arguments:
1. Table column command (IN).
2. Table column cmdstatus (IN).
3. Table column cap (IN).
4. Table column cmdrowStatus (IN).
Return type:
SUCCESS or FAILURE.
Bugs:
null

CreateAndAddTl1CommandSecurityTableEntry()

CHAR CreateAndAddTl1CommandSecurityTableEntry(OID *instance, INT32 instanceLen, U_CHAR *command, INT32 cmdstatus, U_CHAR *cap, INT32 cmdrowStatus)

It will take all columns value and its instance value as input and add create an entry then add it to the vector.

Arguments:
1. Instance Oid (IN).
2. Instance Oid Length (IN).
3. Table column command (IN).
4. Table column cmdstatus (IN).
5. Table column cap (IN).
6. Table column cmdrowStatus (IN).
Return type:
SUCCESS or FAILURE.
Bugs:
null

CreateTl1CommandSecurityTableInstance()

OID* CreateTl1CommandSecurityTableInstance(INT32 *instanceLen, U_CHAR *command)

This method is called from the method CreateAndAddNewTl1CommandSecurityTableTableEntry(). It is used to create a oid representation of the instance value by taking table index columns value as input.

Arguments:
1. Instance Oid Length(IN/OUT).
2. Table column command (IN).
Return type:
Nothing.
Bugs:
null

CreateTl1CommandSecurityTableRowWithDefaultValues()

void* CreateTl1CommandSecurityTableRowWithDefaultValues(U_CHAR **indexList, INT32 *indexListLen, INT32 len)

It will create a new row and assign default value for each table column. For index column it will assign the value from input argument (index).

Arguments:
1. List of index values (IN).
2. Length of each index value (IN).
3. Length of the index list (IN).
Return type:
Created aaplicationTable row pointer.
Bugs:
null

FreeTl1CommandSecurityTableEntryMemory()

void FreeTl1CommandSecurityTableEntryMemory(Entry *entryPtr)

This method is called from FreeTl1CommandSecurityTableVector(). This method is used to free the reserved memory for an entry while deleting an entry from the vector. The user can also call this method to free a particular entry in the table vector.

Arguments:
1. Reference of the table entry (IN).
Return type:
Nothing.
Bugs:
null

FreeTl1CommandSecurityTableVector()

void FreeTl1CommandSecurityTableVector()

Free the gv_tl1CommandSecurityTableVector.

Arguments:
Nothing.
Return type:
Nothing.
Bugs:
null
See Also:
FreeTl1CommandSecurityTableEntryMemory()
CreateTl1CommandSecurityTableRowWithDefaultValues()

GetCap()

U_CHAR* GetCap(void *tableEntryPtr, INT32 *varValLen, U_CHAR *status)

Get method for (table) column cap. command access previlages

Arguments:
1. Pointer of the entry (IN).
2. Pointer of the variable value length (OUT).
3. Status which is used to return SNMP Error (OUT).
Return type:
The Current value of "cap".
Bugs:
null
See Also:
SetCap()

GetCmdrowStatus()

U_CHAR* GetCmdrowStatus(void *tableEntryPtr, INT32 *varValLen, U_CHAR *status)

Get method for (table) column cmdrowStatus. Column Description

Arguments:
1. Pointer of the entry (IN).
2. Pointer of the variable value length (OUT).
3. Status which is used to return SNMP Error (OUT).
Return type:
The Current value of "cmdrowStatus".
Bugs:
null
See Also:
SetCmdrowStatus()

GetCmdstatus()

U_CHAR* GetCmdstatus(void *tableEntryPtr, INT32 *varValLen, U_CHAR *status)

Get method for (table) column cmdstatus. in/out of service

Arguments:
1. Pointer of the entry (IN).
2. Pointer of the variable value length (OUT).
3. Status which is used to return SNMP Error (OUT).
Return type:
The Current value of "cmdstatus".
Bugs:
null
See Also:
SetCmdstatus()

GetCommand()

U_CHAR* GetCommand(void *tableEntryPtr, INT32 *varValLen, U_CHAR *status)

Get method for (table) column command. command code

Arguments:
1. Pointer of the entry (IN).
2. Pointer of the variable value length (OUT).
3. Status which is used to return SNMP Error (OUT).
Return type:
The Current value of "command".
Bugs:
null
See Also:
SetCommand()

GetTl1CommandSecurityTableEntry()

U_CHAR GetTl1CommandSecurityTableEntry(U_CHAR ***cols,INT32**colsLen,INT32 index)

It will get an entry from table.

Arguments:
1.Table columns (IN).
2. Columns length (IN).
Return type:
SUCCESS/FAILURE.
Bugs:
null

GetTl1CommandSecurityTableInfo()

Vector* GetTl1CommandSecurityTableInfo(INT32 startIdx, INT32 numOfRows, INT32 *flag)

It will return the table vector reference, before that it will verify the total size of the table and set flag value.

Arguments:
1. Starting Row index (IN).
2. Number of rows (IN).
3. Flag about remaining number of rows (OUT).
Return type:
Nothing.
Bugs:
null

InitTl1CommandSecurityTable()

void InitTl1CommandSecurityTable(void)

It will register the treeCell with agent and initialize all data structures related to the module "tl1CommandSecurityTable".

Arguments:
Nothing.
Return type:
Nothing.
Bugs:
null
See Also:
CreateAndAddNewTl1CommandSecurityTableEntry()

SetCap()

U_CHAR* SetCap(void *tableEntryPtr, U_CHAR *varVal, INT32 *varValLen, U_CHAR *status)

Set method for (table) column cap. command access previlages

Arguments:
1. Pointer of the entry (IN/OUT).
2. Pointer of the variable to set (IN).
3. Pointer of the variable value length (IN/OUT).
4. Status which is used to return SNMP Error (IN/OUT).
Return type:
The Current value of "cap".
Bugs:
null
See Also:
GetCap()

SetCmdrowStatus()

U_CHAR* SetCmdrowStatus(void *tableEntryPtr, U_CHAR *varVal, INT32 *varValLen, U_CHAR *status)

Set method for (table) column cmdrowStatus. Column Description

Arguments:
1. Pointer of the entry (IN/OUT).
2. Pointer of the variable to set (IN).
3. Pointer of the variable value length (IN/OUT).
4. Status which is used to return SNMP Error (IN/OUT).
Return type:
The Current value of "cmdrowStatus".
Bugs:
null
See Also:
GetCmdrowStatus()

SetCmdstatus()

U_CHAR* SetCmdstatus(void *tableEntryPtr, U_CHAR *varVal, INT32 *varValLen, U_CHAR *status)

Set method for (table) column cmdstatus. in/out of service

Arguments:
1. Pointer of the entry (IN/OUT).
2. Pointer of the variable to set (IN).
3. Pointer of the variable value length (IN/OUT).
4. Status which is used to return SNMP Error (IN/OUT).
Return type:
The Current value of "cmdstatus".
Bugs:
null
See Also:
GetCmdstatus()

SetCommand()

U_CHAR* SetCommand(void *tableEntryPtr, U_CHAR *varVal, INT32 *varValLen, U_CHAR *status)

Set method for (table) column command. command code

Arguments:
1. Pointer of the entry (IN/OUT).
2. Pointer of the variable to set (IN).
3. Pointer of the variable value length (IN/OUT).
4. Status which is used to return SNMP Error (IN/OUT).
Return type:
The Current value of "command".
Bugs:
null
See Also:
GetCommand()

Tl1CommandSecurityTableProcessReqeusts()

CHAR Tl1CommandSecurityTableProcessRequests(U_CHAR protoType,U_CHAR cmdType, Vector *attrbsVect, INT32 numOfRows)

This method will be called from the agent api for all the requests (GET/GET-NEXT/SET) with received pduType and varBind vector before processing the received varbinds. The purpose of this method call is, the user can know the set of varBinds (OIDs') received for a listener. Using these inputs user may do some validation or call his application method and update the local data structure. User has to specify the error status and error index.

Arguments:
1. PduType (GET/GET-NEXT) (IN/OUT).
2. attrbsVect vector (IN/OUT).
3. Future Use.
4. Future Use.
Return type:
SUCCESS or FAILURE.
Bugs:
Return value of method is not handled in AgentAPI.

UpdateTl1CommandSecurityTable()

CHAR UpdateTl1CommandSecurityTable(U_CHAR command)

This method will be called from the agent api after successful SET/GET/GET-NEXT operation, in order to update the original or user application's data structrue with the changes made to Tl1CommandSecurityTable. If FILE_TO_VECTOR is enabled then the corresponding text file will be updated here. If the storagetype is NoStorage then the user should call this method to update the changes done by the management.The user can also free the resources in this function if required.

Arguments:
command type.
Return type:
SUCCESS or FAILURE.
Bugs:
null
OverView Index Help                                                                WebNMS Agent Toolkit C Edition 6 
Copyright (c) 2009 ZOHO Corp. All Rights Reserved.