OverView Index Help                                                                WebNMS Agent Toolkit C Edition 6 
wwwrequestintablehdlr.c.
To handle the requests from the manager for the module wwwrequestintable. The table providing detailed statistics for requests received by WWW services on this system. Request statistics for an individual service.

See Also :wwwrequestintable.h.
Return Type Method Summary
CHAR CreateAndAddNewWwwRequestInTableEntry(U_INT32 wwwServiceIndex, U_CHAR *wwwRequestInIndex, U_INT32 wwwRequestInRequests, U_INT32 wwwRequestInBytes, U_CHAR *wwwRequestInLastTime)
             It will take all columns value as input and create an instance then add it to the vector.
CHAR CreateAndAddWwwRequestInTableEntry(OID *instance, INT32 instanceLen, U_INT32 wwwServiceIndex, U_CHAR *wwwRequestInIndex, U_INT32 wwwRequestInRequests, U_INT32 wwwRequestInBytes, U_CHAR *wwwRequestInLastTime)
             It will take all columns value and its instance value as input and add create an entry then add it to the vector.
OID* CreateWwwRequestInTableInstance(INT32 *instanceLen, U_INT32 wwwServiceIndex, U_CHAR *wwwRequestInIndex)
             This method is called from the method CreateAndAddNewWwwRequestInTableTableEntry().
void FreeWwwRequestInTableEntryMemory(Entry *entryPtr)
             This method is called from FreeWwwRequestInTableVector().
void FreeWwwRequestInTableVector()
             Free the gv_wwwRequestInTableVector.
U_CHAR* GetWwwRequestInBytes(void *tableEntryPtr, INT32 *varValLen, U_CHAR *status)
             Get method for (table) column wwwRequestInBytes.
U_CHAR* GetWwwRequestInLastTime(void *tableEntryPtr, INT32 *varValLen, U_CHAR *status)
             Get method for (table) column wwwRequestInLastTime.
U_CHAR* GetWwwRequestInRequests(void *tableEntryPtr, INT32 *varValLen, U_CHAR *status)
             Get method for (table) column wwwRequestInRequests.
U_CHAR GetWwwRequestInTableEntry(U_CHAR ***cols, INT32 index)
             It will get an entry from table.
Vector* GetWwwRequestInTableInfo(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 InitWwwRequestInTable()
             It will register the treeCell with agent and initialize all data structures related to the module "wwwRequestInTable".
CHAR ReadFromWwwRequestInTableFile()
             It will read the "wwwRequestInTable" enteries from the file and add it to the table(vector).
U_CHAR* SetWwwRequestInBytes(void *tableEntryPtr, U_CHAR *varVal, INT32 *varValLen, U_CHAR *status)
             Set method for (table) column wwwRequestInBytes.
U_CHAR* SetWwwRequestInIndex(void *tableEntryPtr, U_CHAR *varVal, INT32 *varValLen, U_CHAR *status)
             Set method for (table) column wwwRequestInIndex.
U_CHAR* SetWwwRequestInLastTime(void *tableEntryPtr, U_CHAR *varVal, INT32 *varValLen, U_CHAR *status)
             Set method for (table) column wwwRequestInLastTime.
U_CHAR* SetWwwRequestInRequests(void *tableEntryPtr, U_CHAR *varVal, INT32 *varValLen, U_CHAR *status)
             Set method for (table) column wwwRequestInRequests.
CHAR UpdateWwwRequestInTable(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 WwwRequestInTable.
CHAR WriteToWwwRequestInTableFile()
             It will write the "wwwRequestInTable" enteries from the table(vector).
CHAR WwwRequestInTableProcessRequests(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.
   
Method Details

CreateAndAddNewWwwRequestInTableEntry()

CHAR CreateAndAddNewWwwRequestInTableEntry(U_INT32 wwwServiceIndex, U_CHAR *wwwRequestInIndex, U_INT32 wwwRequestInRequests, U_INT32 wwwRequestInBytes, U_CHAR *wwwRequestInLastTime)

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

Arguments:
1. Parent Table index column wwwServiceIndex (IN).
2. Table column wwwRequestInIndex (IN).
3. Table column wwwRequestInRequests (IN).
4. Table column wwwRequestInBytes (IN).
5. Table column wwwRequestInLastTime (IN).
Return type:
SUCCESS or FAILURE.
Bugs:
null

CreateAndAddWwwRequestInTableEntry()

CHAR CreateAndAddWwwRequestInTableEntry(OID *instance, INT32 instanceLen, U_INT32 wwwServiceIndex, U_CHAR *wwwRequestInIndex, U_INT32 wwwRequestInRequests, U_INT32 wwwRequestInBytes, U_CHAR *wwwRequestInLastTime)

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 wwwRequestInIndex (IN).
4. Table column wwwRequestInRequests (IN).
5. Table column wwwRequestInBytes (IN).
6. Table column wwwRequestInLastTime (IN).
Return type:
SUCCESS or FAILURE.
Bugs:
null

CreateWwwRequestInTableInstance()

OID* CreateWwwRequestInTableInstance(INT32 *instanceLen, U_INT32 wwwServiceIndex, U_CHAR *wwwRequestInIndex)

This method is called from the method CreateAndAddNewWwwRequestInTableTableEntry(). 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. Parent Table index column wwwServiceIndex (IN).
3. Table column wwwRequestInIndex (IN).
Return type:
Nothing.
Bugs:
null

FreeWwwRequestInTableEntryMemory()

void FreeWwwRequestInTableEntryMemory(Entry *entryPtr)

This method is called from FreeWwwRequestInTableVector(). 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

FreeWwwRequestInTableVector()

void FreeWwwRequestInTableVector()

Free the gv_wwwRequestInTableVector.

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

GetWwwRequestInBytes()

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

Get method for (table) column wwwRequestInBytes. The number of content bytes per request type received by this WWW 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 "wwwRequestInBytes".
Bugs:
null
See Also:
SetWwwRequestInBytes()

GetWwwRequestInLastTime()

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

Get method for (table) column wwwRequestInLastTime. The date and time when the last byte of the last complete request of this type was received by this WWW service. The value SHALL be '0000000000000000'H if no request of this type has been received yet.

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 "wwwRequestInLastTime".
Bugs:
null
See Also:
SetWwwRequestInLastTime()

GetWwwRequestInRequests()

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

Get method for (table) column wwwRequestInRequests. The number of requests of this type received by this WWW 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 "wwwRequestInRequests".
Bugs:
null
See Also:
SetWwwRequestInRequests()

GetWwwRequestInTableEntry()

U_CHAR GetWwwRequestInTableEntry(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

GetWwwRequestInTableInfo()

Vector* GetWwwRequestInTableInfo(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

InitWwwRequestInTable()

void InitWwwRequestInTable(void)

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

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

ReadFromWwwRequestInTableFile()

CHAR ReadFromWwwRequestInTableFile()

It will read the "wwwRequestInTable" enteries from the file and add it to the table(vector). After Successfully reading from the file it returns SUCCESS else FAILURE.

Arguments:
Nothing.
Return type:
SUCCESS or FAILURE.
Bugs:
null
See Also:
WriteToWwwRequestInTableFile()

SetWwwRequestInBytes()

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

Set method for (table) column wwwRequestInBytes. The number of content bytes per request type received by this WWW 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 "wwwRequestInBytes".
Bugs:
null
See Also:
GetWwwRequestInBytes()

SetWwwRequestInIndex()

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

Set method for (table) column wwwRequestInIndex. The particular request type the statistics apply to.

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 "wwwRequestInIndex".
Bugs:
null
See Also:

SetWwwRequestInLastTime()

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

Set method for (table) column wwwRequestInLastTime. The date and time when the last byte of the last complete request of this type was received by this WWW service. The value SHALL be '0000000000000000'H if no request of this type has been received yet.

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 "wwwRequestInLastTime".
Bugs:
null
See Also:
GetWwwRequestInLastTime()

SetWwwRequestInRequests()

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

Set method for (table) column wwwRequestInRequests. The number of requests of this type received by this WWW 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 "wwwRequestInRequests".
Bugs:
null
See Also:
GetWwwRequestInRequests()

UpdateWwwRequestInTable()

CHAR UpdateWwwRequestInTable(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 WwwRequestInTable. 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

WriteToWwwRequestInTableFile()

CHAR WriteToWwwRequestInTableFile()

It will write the "wwwRequestInTable" enteries from the table(vector). After successfully writing into the file it returns SUCCESS else FAILURE.

Arguments:
Nothing.
Return type:
SUCCESS or FAILURE.
Bugs:
null
See Also:
ReadFromWwwRequestInTableFile()

WwwRequestInTableProcessReqeusts()

CHAR WwwRequestInTableProcessRequests(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.
OverView Index Help                                                                WebNMS Agent Toolkit C Edition 6 
Copyright (c) 2009 ZOHO Corp. All Rights Reserved.