OverView Index Help WebNMS Agent Toolkit C Edition 6
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
G
GenBlockParser
Parses General Block.
GenEngineId
Using this method user can generate SNMPV3 engineId. If the user wants default engineId generation then he can return NULL. NOTE: While creating engineId use dynamic memory allocation.
GenerateDelayValue
It will assign the delay value for an thread which is used in the case of resource lock is failed. For each invocation this method will assign diffent delay value with the scale value of 10 Micro seconds.
GenerateEngineId
Used to generate a engine Id based on the agent address and port number.
GenerateOptParamParser
Parsing the given message to generate optionParam Parser.
GeneratePrompt
Checking the promptlevel value and fetch the prompt string in to the TxQueue.
GenerateResponseMessage
The Response Message is fetch in to the Queue.
GenerateSalt
Generate a unique radom value for the salt variable using gv_engieBootCnt and gv_engineTime.
GeneratecommadShell
Generate commandShell for cliResMesgPtr from the cliMesgPtr.
GetAction
This method will be called by CLI Engine upon receiving the CLI command.Here, user can write his code to perform the necessary action upon receiving the CLI command.
GetAgentAddress
It will find the mathing varbind for snmpTrapAddress oid and return the corresponding value as agentAddress. If no mathing is found then it will return "0.0.0.0" as agentAddress.
GetAgentContact
Get method for scalar variable agentContact. The textual identification of the contact person for this managed node(agent), together with information on how to contact this person.
GetAgentIPAddress
It will find out the machine IP address and copy the value to gptr_agentAddress variable. Here we are using the macro AGENT_ADDRESS instead of that user can find out the machine IP address and copy it to gptr_agentAddress variable.
GetAgentId
Get method for scalar variable agentId.
GetAgentPlatform
Get method for scalar variable agentPlatform. The Platform (Operating System) on which the agent is running.
GetAgentStartUpTime
To get the starting time of the agent.
GetAgentStartUpTime
To get the starting time of the agent.
GetAgentStartUpTime
To get the starting time of the agent.
GetAgentStartUpTime
To get the starting time of the agent.
GetAgentTime
To get the current time of the agent.
GetAgentTime
To get the current time of the agent. To generate trap message the return time will be in milli seconds and for SNMPV3 authentication the time will be in seconds.
GetAgentTime
To get the current time of the agent.
GetAgentTime
To get the current time of the agent. To generate trap message the return time will be in milli seconds and for SNMPV3 authentication the time will be in seconds.
GetAgentUpTime
Get method for scalar variable agentUpTime. The time (in hundredths of a second) since the network management portion of the agent was last re-initialized.
GetAgentVendorName
Get method for scalar variable agentVendorName. Agent vendor name.
GetAgentVersion
Get method for scalar variable agentVersion. Version of the Agent Server.
GetAid
Returns AID from input command from input message.
GetAllCommand
Get all Reg command and format all command to display.
GetKeyString
Get the special key string.
GetAttrbValue
Compare each Attribute's paramName with given name and return the paramValue if it matches.
GetAttribInfo
Gets the corresponding column/scalar Attribute Information based on the column name coming as argument from given moduleInfoPtr.
GetAttributeIndex
It will find out the exact position/order of the column/scalar from the subId list.
GetAttributeValue
It will return the give attribute value by invoking its get method from the agent instrumentation. In the case of table module then the user should find out the corresponding row of the given column he wished to retrive the value.
*GetAttributesValue
Take each Attribute name and get its value by invoking Get method call. After that memory will be allocated for the return value and will be stored in the given retVals variable. So the calling method should free the reserved memory after use.
GetAuthKeyLength
Determines the length of the authKey.
GetCLIArgumentAt
Getting argument value for the given index is in the StringCommand.
GetCLIArgumentAtString
Getting argument value for the given argument name is in the StringCommand.
GetCLIClientSession
It will get the client session entry from the server session entry for the given session ID.
GetCLIClientSessionByServer
It will get the client session entry from the server session entry for the given session ID.
GetCLICommandFromMesg
Get the command from message.
GetCLICommandRegisterInfo
Searching given command in command register.
GetCLIOption
Using indexPtr as reference to Get option value and parameter value from the given Stringcommand.
GetCLIParameter
Getting parameter value for the given option.
GetCLIServerSession
It will search the server session vector for the given session ID and it will return that server session if it finds.
GetCap
Get method for (table) column cap. command access previlages
GetCliCommIfcIndex
Get method for (table) column cliCommIfcIndex. CLI communication interface index, it is just a numeric value which will be assigned during row creation.
GetCliCommIfcInfo
Get method for (table) column cliCommIfcInfo. Detailed information about the supported CLI transport protocol.
GetCliCommIfcTableEntry
It will get an entry from table.
GetCliCommIfcTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetCliCommIfcType
Get method for (table) column cliCommIfcType. The supported CLI communication interface type between NE and OSS.
GetCliOperStatus
Get method for scalar variable cliOperStatus. CLI agent (adapter) status, if it is one (1) it means CLI agent is running. If it is zero (0) it means CLI agent is not running.
GetCliTcpConnIpAddress
Get method for (table) column cliTcpConnIpAddress. IP address used for this connection.
GetCliTcpConnPortNumber
Get method for (table) column cliTcpConnPortNumber. Port number used for this connection.
GetCliTcpConnStatus
Get method for (table) column cliTcpConnStatus. The state of this TCP/IP connection. The state will be either Operational or Blocked.
GetCliTcpTableEntry
It will get an entry from table.
GetCliTcpTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetCliUpTime
Get method for scalar variable cliUpTime. CLI agent(adapter) uptime in hundredths second.
GetCliVersion
Get method for scalar variable cliVersion. CLI agent (adapter) version.
GetCmdEntrystatus
retreives command status.
GetCmdrowStatus
Get method for (table) column cmdrowStatus. Column Description
GetCmdstatus
Get method for (table) column cmdstatus. in/out of service
GetColumnAttributeInfo
It will return the column Attribute pointer of the given index .
GetColumnIndex
Search the given column in the subid list, if it is there return corresponding index in the subid list.
GetCommIfcIndex
Get method for (table) column commIfcIndex. Communication interface index it is just a numeric value which will be assigned during row creation.
GetCommIfcInfo
Get method for (table) column commIfcInfo. Detailed information about the transport protocol.
GetCommIfcType
Get method for (table) column commIfcType. The communication interface type.
GetCommand
Get method for (table) column command. command code
*GetCommandList
It willl create a array list of command which the command are register.
GetCommandUsage
The funciton will create command usage string for the given commandReg.
GetCompleteMesgFromCmdcode
returns the command code's defined syntax
GetContentType
It will find out the content type value to place it in the response header based on the type of file.
GetCounterMonitor
It will retrive the Counter Monitor corresponding to the given ID. This method search the counter monitor table, and return the counter monitor reference if available, otherwise NULL will be returned.
GetCurrentSystemTime
It will find out the current system time in seconds.
GetCurrentSystemTime
It will find out the current system time in seconds.
GetCurrentSystemTime
It will find out the current system time in seconds.
GetCurrentSystemTime
It will find out the current system time in seconds.
GetCurrentTimeInrfcFmt
Gets the Current time in rfc1123 format and stores the formatted time in the buf variable.
GetDataInChunks
Gets the chunk data one by one.
GetDefaultMxinv
Assigns default Mxinv value.
GetDefaultPoint
Assigns default POINT value.
GetDefaultUout
get default uout value.
GetDigest
This function will calculate the digest using the given parameters as defined in the USM security model in RFC 3414.
GetDocCtrlTableEntry
If the DocCtrlTable size is 1, then it returns a a reference of the table. This is the table that controls every other document table.
GetEntry
It reterives the instance from the received oid, with this instance it will compare with instances of the table Vector. Depending upon the command it will return appropriate element from the Vector.
GetEntryByIndex
It will return the indexth Entry of Vector. Here index value starts from 1.
GetEntryByInstance
If any of the Entry's instance of the Vector match with received instance then it will return the corresponding Entry, NULL Otherwise.
GetEntryFromInformInfoList
It will find the corresponding Entry's inform Id from the gv_informInfoListVect which matches the informId of the rcvd reponse message.
GetErr304responses
Get method for scalar variable err304responses. Description
GetErr400responses
Get method for scalar variable err400responses. Description
GetErr401responses
Get method for scalar variable err401responses. Description
GetErr403responses
Get method for scalar variable err404responses. Description
GetErr404responses
Get method for scalar variable err404responses. Description
GetErr408responses
Get method for scalar variable err408responses. Description
GetErr412responses
Get method for scalar variable err412responses. Description
GetErr501responses
Get method for scalar variable err501responses. Description
GetErr505responses
Get method for scalar variable err505responses. Description
GetErrorMessage
Assigning Error message to the cliMessage Ptr.
GetErrorStatusAndErrorIndex
This function go through each varbind of received responses from the sub agent and results optained from the master agent and find out the error index value if snmp error is occured, otherwise zero will be returned.
GetErrorString
Get error sting for the given error number.
GetErrorresponses
Get method for scalar variable errorresponses. Description
GetExactEntry
Depending upon the command it will search the corresponding element from the table Vector.
GetExternalIdxValue
This function finds out the value of the external index from the entry pointer which has the instance.
GetExternalIndexCount
Counts external indexes.
GetExternalIndexValue
It traverse the given instance according to the given index data types and the give location value. And copy the required index value to the another variable called index and return back the value as a result.
GetExternalIndexValue
It traverse the given instance according to the given index data types and the give location value. And copy the required index value to the another variable called index and return back the value as a result.
GetFapList
Get method for (table) column fapList. field acces previlage list
GetFieldValuesFromDBS
Retrives all column values from database for the given SQL select query string.
GetFieldValuesFromDBS
Retrives all column values from database for the given SQL select query string.
GetFieldValuesFromDBS
Retrives all column values from database for the given SQL select query string.
GetFileLength
It will calculate the length of the file which is coming as argument and returns it .
GetGaugeMonitor
It will retrive the Gauge Monitor corresponding to the given ID. This method search the gauge monitor table, and return the gauge monitor reference if available, otherwise NULL will be returned.
GetGetrequests
Get method for scalar variable getrequests. Description
GetHeadrequests
Get method for scalar variable headrequests. Description
GetHelpString
Read help string from buffer array.
GetHexValue
Convert the given character into hexa value.
GetHostIpAddress
It will get the ip address of the local machine. After calling this function input argument should freed as it is allocated inside the fumction.
GetHttpIpAddress
Get method for scalar variable httpIpAddress. It is the IP address used by the HTTP agent to receive and send requests and responses.
GetHttpMaxSockFd
Finds out the maximum socket descriptor value among Server Socket Descriptor and clients descriptors.
GetHttpOperStatus
Get method for scalar variable httpOperStatus.
GetHttpPortNumber
Get method for scalar variable httpPortNumber.
GetHttpUpTime
Get method for scalar variable httpAdapterUpTime.
GetHttpVersion
Get method for scalar variable httpVersion.
GetIncrementedSeqNum
It will increment the given sequence number and return the incremented value.
GetIndex
It will find out the index of the character in the string.
GetIndexAttributeIndex
This function find out the index of the column Attribute for the given index name.
GetIndirectDataRtrv
Returns indirect data retrieval value.
GetInformId
It will return the unique inform Id with which inform response can be identified for the respective inform response.
GetInformIdFromInformVector
Assign the corresponding Entry's inform Id from the gv_informVector which matches the reqId of the rcvd reponse message.
GetInstance
Get each oid one by one from the location pointed by the (oid + startLen), until len is reached.
GetInstanceValue
This function takes the entry pointer and finds out the instance fronm the entry pointer and returns it as a string.
GetIpaddress
Get method for (table) column ipaddress. Column Description
GetLastLoginTimeofUser
retreive user's lastlogin time .
GetLastModifiedTimeInrfcFmt
Reads a file and converts the last modified time in rfc1123 format. The formatted modified time is stored in the buf variable.
GetLastNTimeStamp
Converts the timeInSecs to the formatted date time value.
GetLastreqtime
Get method for (table) column lastreqtime. Column Description
GetLength
Parses the chunk data and finds out the the length of the chunk. Converts the length which is in hexa to decimal.
GetListener
Using the given OID this function will find out the corresponding tree cell from the tree based on the command and version. If the tree cell is found then tree cell will be returned otherwise NULL will be returned.
GetListofRegdCmds
Lists all the Registered command codes in log file
GetMPBParam
Returns paramter from input command message payload block.
GetMPBParamCnt
Counts parameter in a block.
GetMPBParamValue
Returns paramter from input command message payload block.
GetMPBParamValueByName
It searches the given name of parameter in Message payload parameter vector and returns value.
GetMasterAgentErrorStatusAndErrorIndex
It is used find out the SNMP error status and error index among the grouped varBinds for the master agent.
GetMaxSessionId
Find the highest sessionId present in the gv_sessionsTable.
GetMessageType
Returns message type ie.response,autonomous,acknowledgement
GetModifiedTime
Converts the time in rfc1123 format and stores the formatted time in the buf variable.
GetModifier1
Returns modifier one from input message.
GetModifier2
Returns modifier two from the input message.
GetModuleInfoForTreeCell
It will findout the Module Info pointer corresponding to treecell using lable of treecell.
GetModuleInfoFromOptArray
It will search for the attribute name in the gv_optimizeArray and returns the corresponding moduleInfoPtr.
GetMonitor
It will retrive the Monitor corresponding to the given ID. This method search the monitor table, and return the monitor reference if available, otherwise NULL will be returned.
GetMxinvofChannel
retreives Mxinv value of channel.
GetNOid
Get each oid from the srcOid and copy to destOid from startIndex to startIndex + len.
GetNextForGetBulkVarBinds
This function get all varbind and do GET-NEXT once.
GetNextOid
Compares the received oid from the varbind with oid (oid of tree cell + each Entry of subid list) then return the next greater oid.
GetNextSubId
Take each oid from the subid list and compare with given column oid if it is next greater value then return its value.
GetNotifrequests
Get method for scalar variable notifrequests. Description
GetNthElement
Reterive the element at specified location from the nodePtr.
GetNthTreeCell
Comapre each value of the fist OID with corresponding value of the second OID.
GetNumOfOccurencesOfTimerNotification
It will count the given "id" in gv_timerServiceTable and return the total count.
GetNumrequests
Get method for (table) column numrequests. Column Description
GetNumresponses
Get method for (table) column numresponses. Column Description
GetOidLength
It will calculate the length of the oid from char ptr.
GetOperationRowStatus
Get method for (table) column operationRowStatus. Column Description
GetOperationStatus
Get method for (table) column operationStatus. in/out of service
GetOperationaid
Get method for (table) column operationaid. resource name
GetOprEntryStatus
retreives status of a new opr .
GetOprEntryfapListVector
retreives FAP vector for the given aid.
GetOptionParamUsage
Append optionparam usage sting to the sting buffer.
GetOrGetNextRowPtr
It will find out the corresponding row ptr which matches the given indexes.
GetPageofUser
retreive User's PAGE details.
GetParamValue
It will compare each Entry's parameter name with given parameter name if it matches it will return the corresponding parameter value otherwise will retrun NULL.
GetParameterTypeString
This function takes parameter from the message by using parameter name and convert the parameter string to corresponding parameter datatype..
GetPduFromQue
It will compare the req id of pdu taken from que. If any element is matched it will return the reference of the corresponding Pdu.
GetPduVersionForAuthenticationTrap
It will return the pdu vesrion. User can comment any one of the following line according to his requiremnet.
GetPointofUser
retreive user's point value
GetPortno
Get method for (table) column portno. Column Description
GetPostrequests
Get method for scalar variable postrequests. Description
GetProcessedrequests
Get method for scalar variable processedrequests. Description
GetProtocolType
It will compare the rcvd Auth/Priv protocol and assigns value for the protocol type.
GetProxyTableInfo
It will return the table Vector reference, before that it will verify the total size of the table and set flag value.
GetProxyTimeOutErrorIndex
To get error status and error index for time out cases.
GetProxyTimeOutValue
This function go throug each Entry of the proxy Vector and find out the maximum timeOut value.
GetProxyTrapVersion
This function will return a SNMP version, using this version the master agent convert the received trap and forward it to all the registered managers.
GetRciList
Get method for (table) column rciList. list of channels/users allowed
* GetRegisterCmdList
Retrieves registered commands list
GetRegisterInfo
It will search for the given ObjectName in AgentServer, if it is available then it will return the corresponding ModuleInfo reference. This method can be used when processing a received request in a adaptor.
GetRequestType
A Request message corresponding to the requestType is generated.
GetResourceLength
It will calculate the length of the Resource which is coming as argument and returns it .
GetRespMesgheader
retrieves header part of message
GetResponseFromScrollVector
Generate Format table string and append to string buffer.
GetRoutingEntryFromIndex
given an index ,the corresponding Entry is retreived
GetRoutingEntryIndexFrmRouteID
Retreives the index of Routing Entry for Routing identifier.
GetRoutingEntryIndexList
Identifies the target NEs based on router identifier and returns the index list of routing entries to be has to provide code to update records to external routed to.
GetRowIndexByEntry
It will return the index corresponding to the matching entry pointer.
GetRowIndexByInstance
It will return the index corresponding to the matching entry instance.
GetRowStatusColumnPtr
Gets the Row status column Attribute Information for the given module.
GetRsrcEntryStatus
returns status of rsrc.
GetSIDFromUser
It returns SID.
GetSentresponses
Get method for scalar variable sentresponses. Description
GetServerTPName
Retreives the TP name for a given client sessionID.
GetSessionID
Retreives SessionID for given User .
GetSessionPtr
finds the sessionPtr corresponding to the sessionId.
GetSessionTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetSessionid
Get method for (table) column sessionid. Column Description
GetSessionstate
Get method for (table) column sessionstate. Column Description
GetSnmpMsgVersion
This function will find the received SNMP v3 message version.
GetSnmpNotificationLogTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetSnmpNotificationVarBindTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetSnmpSysOrTableEntry
It will get an Entry from table
GetSnmpSysOrTableInfo
It will return the table Vector reference, before that it will verify the total size of the table and set flag value.
GetSnmpSystemGroupValue
It will retrive the System group mib objects value by making respective OS system calls.
GetSnmpUsmUserTableInfo
It will return the table Vector reference, before that it will verify the total size of the table and set flag value.
GetSnmpVacmAccessTableInfo
It will return the table Vector reference, before that it will verify the total size of the table and set flag value.
GetSnmpVacmContextTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetSnmpVacmSecurityToGroupTableInfo
It will return the table Vector reference, before that it will verify the total size of the table and set flag value.
GetSnmpVacmViewTreeFamilyTableInfo
It will return the table Vector reference, before that it will verify the total size of the table and set flag value.
GetStandardTrapOidVal
This function will copy the standard trap oid value (cold, warm etc), according to the trap type
GetStartUpTrapTypeAndPduVersion
It will fill up the startup trap type and pdu vesrion. User can comment any one of the following line for trap type and pdu version according to his requiremnet.
GetStatusMsg
A Status/Error message corresponding to the errStatus is formed.
GetStatusofChannel
retreives status of channel .
GetStrDuralofChannel
retreives dural value of channel.
GetStringCommandObject
Get a complete string which concate all object command.
GetStringMonitor
It will retrive the String Monitor corresponding to the given ID. This method search the string monitor table, and return the string monitor reference if available, otherwise NULL will be returned.
GetStringToken
Parsing the given message to generate the String token.
*GetSubCommands
It will create an array list of sub commands of the command specified.
GetSysuptime
It will take the sysuptime value from the first varbind and return.
GetTL1ClientSession
Retreives client details for the sessionID.
GetTagInfoEntry
This function will return the TagInfoEntry of the command.
GetTcpConnIpAddress
Get method for (table) column tcpConnIpAddress. IP address used for this connection.
GetTcpConnPortNumber
Get method for (table) column tcpConnPortNumber. Port number used for this connection.
GetTcpConnStatus
Get method for (table) column tcpConnStatus. The state of this TCP/IP connection. The state will be either Operational or Blocked.
GetTime
GetTimerNotification
It will match the given "id" in the gv_timerServiceTable if matched return the corresponding TimerNotificationInfo otherwise NULL will be returned.
GetTl1CommIfcTableEntry
It will get an entry from table
GetTl1CommIfcTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetTl1CommandSecurityTableEntry
It will get an entry from table.
GetTl1CommandSecurityTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetTl1OperStatus
Get method for scalar variable tl1OperStatus. HTTP Server status, if it is one (1) it means HTTP server (adapter) is running. If it is zero (0) it means HTTP server (adapter) is not running.
GetTl1OperationSecurityTableEntry
It will get an entry from table.
GetTl1OperationSecurityTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetTl1TcpTableEntry
It will get an entry from table
GetTl1TcpTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetTl1UpTime
Get method for scalar variable tl1UpTime. TL1 agent(adapter) uptimer.
GetTl1Version
Get method for scalar variable tl1Version. TL1 adapter version.
GetTrapReceiverTableInfo
It will return the table Vector reference, before that it will verify the total size of the table and set flag value.
GetTrapVariableInfo
It will get the TreeCell from the agent tree using the given key then it will copy the oid and assign the trap variable syntax.
GetTreeCell
This will return a tree cell corresponding to the given oid.
GetTreeCellByName
It will check each tree cell's label with given key, if it matches then return the corresponding tree cell.
GetUoutofUser
retreive Uout of User.
GetUsage
This function will be called when get command is received with invalid options.User can cutomize the usage string to his requirements.
GetUserID
Retreives the userID for a given SessionID .
GetUserSecurityEntry
Retrieves user details for the given UserID.
GetUserStatus
retreive user status(IS/OOS).
GetUsmEntry
It is used to get an Entry from the USM table after matching with engineId and user name.
GetVarBindAndSetAgain
This function is called if mulitvar set is failed. Retrieve each Entry from the given Vector and will do the set with original(previous) value.
GetVarBindForMatchingOidInVector
It will compare the oid with each oid in the Vector from the fromIndex. If any matching is found then it will return the corresponding varBindPtr.
GetVarEntry
It will get the variable Entry using the given varName.
GetVectorStartIndex
This function check each varbind state value, if any of the varbind state value is TOBE_PROCESSED then it will return that index value. It is assuming that all the vabinds state values are proper.
GetVerb
Returns verb from the parsed input message.
GetView
Get method for (table) column view. view name
GetWwwDocAccessTopNAccesses
Get method for (table) column wwwDocAccessTopNAccesses. The total number of access attempts for this document.
GetWwwDocAccessTopNBytes
Get method for (table) column wwwDocAccessTopNBytes. The total number of content bytes that were transmitted as a result of attempts to access this document.
GetWwwDocAccessTopNLastResponseType
Get method for (table) column wwwDocAccessTopNLastResponseType. The protocol response type which was sent to the client as a result of the last attempt to access this document. This object contains the type of the primary response if there were multiple responses to a single request.
GetWwwDocAccessTopNName
Get method for (table) column wwwDocAccessTopNName. The name of the document for which access was attempted.
GetWwwDocAccessTopNTableEntry
It will get an entry from table.
GetWwwDocAccessTopNTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetWwwDocBucketAccesses
Get method for (table) column wwwDocBucketAccesses. The total number of access attempts for any document provided by this WWW service during the time interval over which this bucket was created.
GetWwwDocBucketBytes
Get method for (table) column wwwDocBucketBytes. The total number of content bytes which were transferred from this WWW service during the time interval over which this bucket was created.
GetWwwDocBucketDocuments
Get method for (table) column wwwDocBucketDocuments. The total number of different documents for which access was attempted this this WWW service during the time interval over which this bucket was created.
GetWwwDocBucketTableEntry
It will get an entry from table.
GetWwwDocBucketTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetWwwDocBucketTimeStamp
Get method for (table) column wwwDocBucketTimeStamp. The date and time when the bucket was made available.
GetWwwDocBytesTopNAccesses
Get method for (table) column wwwDocBytesTopNAccesses. The total number of access attempts for this document.
GetWwwDocBytesTopNBytes
Get method for (table) column wwwDocBytesTopNBytes. The total number of content bytes that were transmitted as a result of attempts to access this document.
GetWwwDocBytesTopNLastResponseType
Get method for (table) column wwwDocBytesTopNLastResponseType. The protocol response type which was sent to the client as a result of the last attempt to access this document. This object contains the type of the primary response if there were multiple responses to a single request.
GetWwwDocBytesTopNName
Get method for (table) column wwwDocBytesTopNName. The name of the document for which access was attempted.
GetWwwDocBytesTopNTableEntry
It will get an entry from table.
GetWwwDocBytesTopNTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetWwwDocCtrlBucketTimeInterval
Get method for (table) column wwwDocCtrlBucketTimeInterval. The time interval after which a new bucket is created. Changing this object has no effect on existing buckets.
GetWwwDocCtrlBuckets
Get method for (table) column wwwDocCtrlBuckets. The maximum number of buckets maintained by the agent before the oldest bucket is deleted. The buckets are used to populate the wwwDocAccessTopNTable and the wwwDocBytesTopNTable. The time interval captured in each bucket can be configured by setting the wwwDocCtrlBucketTimeInterval object.
GetWwwDocCtrlLastNLock
Get method for (table) column wwwDocCtrlLastNLock. This object allows a manager to lock the wwwDocLastNTable in order to retrieve the wwwDocLastNTable in a consistent state. The agent is expected to take a snapshot of the wwwDocLastNTable when it is locked and to continue updating the real wwwDocLastNTable table so that recent information is available as soon as the wwwDocLastNTable is unlocked again. Setting this object to a value greater than 0 will lock the table. The timer ticks backwards until it reaches 0. The table unlocks automatically once the timer reaches 0 and the timer stops ticking. A manager can increase the timer to request more time to read the table. However, any attempt to decrease the timer will fail with an inconsistentValue error. This rule ensures that multiple managers can simultaneously lock and retrieve the wwwDocLastNTable. Note that managers must cooperate in using wwwDocCtrlLastNLock. In particular, a manager MUST not keep the wwwDocLastNTable locked when it is not necessary to finish a retrieval operation.
GetWwwDocCtrlLastNSize
Get method for (table) column wwwDocCtrlLastNSize. The maximum number of entries in the wwwDocLastNTable.
GetWwwDocCtrlTableEntry
It will get an entry from table.
GetWwwDocCtrlTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetWwwDocCtrlTopNSize
Get method for (table) column wwwDocCtrlTopNSize. The maximum number of entries shown in the wwwDocAccessTopNTable and the wwwDocBytesTopNTable. Changing this object has no effect on existing buckets.
GetWwwDocLastNBytes
Get method for (table) column wwwDocLastNBytes. The number of content bytes that were returned as a result of this attempt to access a document.
GetWwwDocLastNName
Get method for (table) column wwwDocLastNName. The name of the document for which access was attempted.
GetWwwDocLastNRequestType
Get method for (table) column wwwDocLastNRequestType. The protocol request type which was received by the server when this document access was attempted.
GetWwwDocLastNResponseType
Get method for (table) column wwwDocLastNResponseType. The protocol response type which was sent to the client as a result of this attempt to access a document. This object contains the type of the primary response if there were multiple responses to a single request.
GetWwwDocLastNStatusMsg
Get method for (table) column wwwDocLastNStatusMsg. This object contains a human readable description of the reason why the wwwDocLastNResponseType was returned to the client. This object defines the implementation-specific reason if the value of wwwDocLastNResponseType indicates an error. For example, this object can indicate that the requested document could not be transferred due to a timeout condition or the document could not be transferred because a 'soft link' pointing to the document could not be resolved.
GetWwwDocLastNTableEntry
It will get an entry from table.
GetWwwDocLastNTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetWwwDocLastNTimeStamp
Get method for (table) column wwwDocLastNTimeStamp. The date and time of the last attempt to access this document.
GetWwwRequestInBytes
Get method for (table) column wwwRequestInBytes. The number of content bytes per request type received by this WWW service.
GetWwwRequestInLastTime
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.
GetWwwRequestInRequests
Get method for (table) column wwwRequestInRequests. The number of requests of this type received by this WWW service.
GetWwwRequestInTableEntry
It will get an entry from table.
GetWwwRequestInTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetWwwRequestOutBytes
Get method for (table) column wwwRequestOutBytes. The number of content bytes per requests type generated by this WWW service.
GetWwwRequestOutLastTime
Get method for (table) column wwwRequestOutLastTime. The date and time when the first byte of the last request of this type was send by this WWW service. The value SHALL be '0000000000000000'H if no request of this type has been send yet.
GetWwwRequestOutRequests
Get method for (table) column wwwRequestOutRequests. The number of requests of this type generated by this WWW service.
GetWwwRequestOutTableEntry
It will get an entry from table.
GetWwwRequestOutTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetWwwResponseInBytes
Get method for (table) column wwwResponseInBytes. The number of content bytes per response type received by this WWW service.
GetWwwResponseInLastTime
Get method for (table) column wwwResponseInLastTime. The date and time when the last byte of the last complete response of this type was received by this WWW service. The value SHALL be '0000000000000000'H if no response of this type has been received yet.
GetWwwResponseInResponses
Get method for (table) column wwwResponseInResponses. The number of responses of this type received by this WWW service.
GetWwwResponseInTableEntry
It will get an entry from table.
GetWwwResponseInTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetWwwResponseOutBytes
Get method for (table) column wwwResponseOutBytes. The number of content bytes per response type generated by this WWW service.
GetWwwResponseOutLastTime
Get method for (table) column wwwResponseOutLastTime. The date and time when the first byte of the last response of this type was sent by this WWW service. The value SHALL be '0000000000000000'H if response of this type has been send yet.
GetWwwResponseOutResponses
Get method for (table) column wwwResponseOutResponses. The number of responses of this type generated by this WWW service.
GetWwwResponseOutTableEntry
It will get an entry from table.
GetWwwResponseOutTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetWwwServiceContact
Get method for (table) column wwwServiceContact. The textual identification of the contact person for this service, together with information on how to contact this person. For instance, this might be a string containing an email address, e.g. ''.
GetWwwServiceDescription
Get method for (table) column wwwServiceDescription. Textual description of the WWW service. This shall include at least the vendor and version number of the application realizing the WWW service. In a minimal case, this might be the Product Token (see RFC 2068) for the application.
GetWwwServiceLastChange
Get method for (table) column wwwServiceLastChange. The date and time when this WWW service entered its current operational state. The value SHALL be '0000000000000000'H if the time of the last state change is not known.
GetWwwServiceName
Get method for (table) column wwwServiceName. The fully qualified domain name by which this service is known. This object must contain the virtual host name if the service is realized for a virtual host.
GetWwwServiceOperStatus
Get method for (table) column wwwServiceOperStatus. Indicates the operational status of the WWW service.
GetWwwServiceProtocol
Get method for (table) column wwwServiceProtocol. An identification of the primary protocol in use by this service. For Internet applications, the IANA maintains a registry of the OIDs which correspond to well-known application protocols. If the application protocol is not listed in the registry, an OID value of the form {applTCPProtoID port} or {applUDPProtoID port} are used for TCP-based and UDP-based protocols, respectively. In either case 'port' corresponds to the primary port number being used by the protocol.
GetWwwServiceStartTime
Get method for (table) column wwwServiceStartTime. The date and time when this WWW service was last started. The value SHALL be '0000000000000000'H if the last start time of this WWW service is not known.
GetWwwServiceTableEntry
It will get an entry from table.
GetWwwServiceTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetWwwServiceType
Get method for (table) column wwwServiceType. The application type using or realizing this WWW service.
GetWwwSummaryInBytes
Get method for (table) column wwwSummaryInBytes. The number of content bytes received.
GetWwwSummaryInLowBytes
Get method for (table) column wwwSummaryInLowBytes. The lowest thirty-two bits of wwwSummaryInBytes.
GetWwwSummaryInRequests
Get method for (table) column wwwSummaryInRequests. The number of requests successfully received.
GetWwwSummaryInResponses
Get method for (table) column wwwSummaryInResponses. The number of responses successfully received.
GetWwwSummaryOutBytes
Get method for (table) column wwwSummaryOutBytes. The number of content bytes transmitted.
GetWwwSummaryOutLowBytes
Get method for (table) column wwwSummaryOutLowBytes. The lowest thirty-two bits of wwwSummaryOutBytes.
GetWwwSummaryOutRequests
Get method for (table) column wwwSummaryOutRequests. The number of requests generated.
GetWwwSummaryOutResponses
Get method for (table) column wwwSummaryOutResponses. The number of responses generated.
GetWwwSummaryTableEntry
It will get an entry from table.
GetWwwSummaryTableInfo
It will return the table vector reference, before that it will verify the total size of the table and set flag value.
GetOrGetNextAttributeValue
Fetches the next or get next Attribute value from the given module Info Pointer.
GettmoutofChannel
retreives tmout value of channel.
CreateUsage
This function will be called when get command is received with invalid options.User can cutomize the usage string to his requirements.
OverView Index Help WebNMS Agent Toolkit C Edition 6
Copyright (c) 2009 ZOHO Corp. All Rights Reserved.