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 

R

RcvCompleteTcpMsgForSnmp

It will parse the header length of the snmp packet.
RcvdCLIMsgInfo

In this function user can do anything on the received information.
RcvdHttpMsgInfo

In this function user can do anything on the received information.
RcvdSnmpMsgInfo

In this function user can do anything on the received information.
RcvdSnmpPduInfo

In this function user will have all the received oid. With the received oid user can contact external application at one shot instead of contacting in XXXProcessRequest() of handler file.
RcvdTL1MsgInfo

In this function user can do anything on the received information.
ReCreateAndSendInformMessage

It will recreate the inform message(to update the sysuptime and request id) and add it to the inform Vector. While calling PollTrapList() created message will be sent.
ReadAConfigLine

Add a line string to the line vector.
ReadALineFromFile

This function reads a line from the file and stores it in the Stringbuffer.
ReadALineFromResource

This function reads a line from the Resource and stores it in the Stringbuffer.
ReadAclAccess

Read method for (table) column aclAccess.
ReadAclCommunity

Read method for (table) column aclCommunity.
ReadAclManagers

Read method for (table) column aclManagers. "This variable has the managers list allowed for specified access with specified community. The format of the string is 'managerName1;managerName2.....' with a list of manager IpAddress/name corresponding to each additional information separated via ';' as the delimiter between any two managers. The default value is '0:0:0:0' which states access for all managers for the corresponding community."
ReadAclStatus

Read method for (table) column aclStatus.
ReadAclTableEntry

It will get an entry from table
ReadAgentCommunity

Get method for (table) column agentCommunity.
ReadAgentHost

Get method for (table) column agentHost.
ReadAgentHostType

Get method for (table) column agentHostType.
ReadAgentPortNumber

Get method for (table) column agentPortNumber.
ReadAgentStatus

Get method for (table) column agentStatus.
ReadAndParseSnmpMessage

This function will read the Snmp message from the master agent and parses the packet and stores it in the PDU.
ReadAuthTableInfo

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

Read Attribute Value for the given mesgptr key.
ReadCommunity

Read method for (table) column community.
ReadContextName

Read method for (table) column contextName.
ReadDisplayStringFromBuffer

Read String form buffer and Set Initial display string for character mode opteration.
ReadDisplayStringFromFile

Read String from file and Set Initial display string for character mode opteration.
ReadFileContents

It will return the contents of the file coming as the argument and returns NULL if it is not available.
ReadFirstWord

The "startPtr" will point to a character stream (line), this method retrive the first word and put it in the variable "word". After the word is retrieved it will return the next word's address in the stream. If there is no word is found then it will return NULL.
ReadFromAgentAuthTableFile

Reads from the text file and updates the authentication Vector. It is used when check for authentication after receiving a request from the manager.
ReadFromAlarmLogFile

read from alarm log file
ReadFromGatewayNEFile

It will read the gateway NE entries from the file and add it to the table(vector). After Successfully reading from the file it returns SUCCESS else FAILURE.
ReadFromManagerTableFile

It will read the table enteries from the file and add it to the Vector.
ReadFromProxyTableFile

It will read the table enteries from the file and add it to the Vector.
ReadFromSecurityLogFile

It will read the security log records from the file and add it to the table(vector). After Successfully reading from the file it returns SUCCESS else FAILURE.
ReadFromSnmpNotificationLogTableFile

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

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

It will read the values from the file and assign it to the corresponding variables. After successfully reading from the file it returns SUCCESS else FAILURE.
ReadFromSnmpSystemFile

It will read the values from the file and assign it to the corresponding variables.
ReadFromSnmpUsmUserTableFile

It will read the table enteries from the file and add it to the Vector.
ReadFromSnmpV3File

Reads from the text file and updates the engine boot count.
ReadFromSnmpVacmAccessTableFile

It will read the table enteries from the file and add it to the Vector.
ReadFromSnmpVacmContextTableFile

It will read the table enteries from the file and add it to the vector.
ReadFromSnmpVacmSecurityToGroupTableFile

It will read the table enteries from the file and add it to the Vector.
ReadFromSnmpVacmViewTreeFamilyTableFile

It will read the table enteries from the file and add it to the Vector.
ReadFromTL1SecurityFiles

Reads and initializes security details from File
ReadFromTrapReceiverTableFile

It will read the table enteries from the file and add it to the Vector.
ReadFromWwwDocAccessTopNTableFile

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

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

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

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

It will read the "wwwDocLastNTable" enteries from the file and add it to the table(vector). After Successfully reading from the file it returns SUCCESS else FAILURE.
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.
ReadFromWwwRequestOutTableFile

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

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

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

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

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

Read help string from Buffer.
ReadHelpStringFromFile

Read help string from file.
ReadHttpMessage

Receives the message.
ReadManagerHost

Read method for (table) column managerHost.
ReadManagerHostType

Read method for (table) column managerHostType.
ReadManagerPort

Read method for (table) column managerPort.
ReadManagerStatus

Read method for (table) column managerStatus.
ReadManagerTableEntry

It will get an entry from table
ReadManagerTableInfo

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

Read method for (table) column managerVersion.
ReadMessageFromCraftInterface

It reads message from craft interface.
ReadMessageFromSerialInterface

It reads message from serial interface.
ReadMsgFromQueueForProcessing

It will read the fist packet from the given queue and delete it from the queue. Then it will return the read packet.
ReadProxyCommunity

Get method for (table) column proxyCommunity.
ReadProxyContextName

Get method for (table) column proxyContextName.
ReadProxyEntryInstance

Get method for (table) column proxyEntryInstance.
ReadProxyHost

Get method for (table) column proxyHost.
ReadProxyHostType

Get method for (table) column proxyHostType.
ReadProxyOid

Get method for (table) column proxyOid.
ReadProxyPortNumber

Get method for (table) column proxyPortNumber.
ReadProxyRetries

Get method for (table) column proxyRetries.
ReadProxySnmpMessage

It will read a SNMP message from the application. The application may be manager/subagent.
ReadProxySnmpVersion

Get method for (table) column proxySnmpVersion.
ReadProxyStatus

Get method for (table) column proxyStatus.
ReadProxyTimeOut

Get method for (table) column proxyTimeOut.
ReadResourceContents

It will return the contents of the Resource coming as the argument and returns NULL if it is not available.
ReadRetries

Read method for (table) column retries.
ReadSSHMessage

Reveives input message from client.
ReadSecLevel

Read method for (table) column secLevel.
ReadSecModel

Read method for (table) column secModel.
ReadSnmpIpAddress

Get method for scalar variable snmpIpAddress. IP address used by the SNMP agent to receive and send requests and responses.
ReadSnmpMessage

It will read a SNMP message from the application. The application may be manager/subagent.
ReadSnmpNotificationCounter32Value

Get method for (table) column notificationCounter32Value. If the trap is sent for a Counter32 value, this particular column gets filled. Else shows a NULL value.
ReadSnmpNotificationCounter64Value

Get method for (table) column notificationCounter64Value. f the trap is sent for a Counter64 value, this particular column gets filled. Else shows a NULL value.
ReadSnmpNotificationIPAddressValue

Get method for (table) column notificationIPAddressValue. If the trap is sent for a IP Address type, this particular column gets filled. Else shows a NULL value.
ReadSnmpNotificationInteger32Value

Get method for (table) column notificationInteger32Value. If the trap is sent for a Integer32 value, this particular column gets filled. Else shows a NULL value.
ReadSnmpNotificationLogOID

Get method for (table) column notificationLogOID. OID for which the Trap is generated to be mentioned here.
ReadSnmpNotificationLogTime

Get method for (table) column notificationLogTime. The upTime of the Agent and the time stating when the Trap was sent.
ReadSnmpNotificationLogVarBinds

Get method for (table) column notificationLogVarBinds. The Varbinds present in the Trap. If the version is of v1 type, the varbinds would be represented in Integer values and if the version is of V2c type, the varbinds would be represented as a combination of the LogTime and LogOID.
ReadSnmpNotificationOIDValue

Get method for (table) column notificationOIDValue. If the trap is sent for a OID value, this particular column gets filled. Else shows a NULL value.
ReadSnmpNotificationOctetStringValue

Get method for (table) column notificationOctetStringValue. If the trap is sent for a OctetString value, this particular column gets filled. Else showsa NULL value.
ReadSnmpNotificationTimeTicksValue

Get method for (table) column notificationTimeTicksValue. If the trap is sent for a TimeTicks value, this particular column gets filled. Else shows a NULL value.
ReadSnmpNotificationUnsigned32Value

Get method for (table) column notificationUnsigned32Value. f the trap is sent for a Unsigned32 value, this particular column gets filled. Else shows a NULL value.
ReadSnmpNotificationVarBindID

Get method for (table) column notificationVarBindID. he ID of the Trap PDU should be specified here.
ReadSnmpNotificationVarBindType

Get method for (table) column notificationVarBindType. Type of the Varbind sent as a Notification.
ReadSnmpNotificationVersion

Get method for (table) column notificationVersion. Version of the Trap to be specified here.
ReadSnmpOperStatus

Get method for scalar variable snmpOperStatus. The run status of the SNMP adapter.
ReadSnmpParamEngineBoots

Get method for scalar variable snmpEngineBoots. The number of times that the SNMP engine has (re-)initialized itself since snmpEngineID was last configured.
ReadSnmpParamEngineID

Get method for scalar variable snmpEngineID. An SNMP engine's administratively-unique identifier.
ReadSnmpParamEngineMaxMessageSize

Get method for scalar variable snmpEngineMaxMessageSize. The maximum length in octets of an SNMP message which this SNMP engine can send or receive and process, determined as the minimum of the maximum message size values supported among all of the transports available to and supported by the engine.
ReadSnmpParamEngineTime

Get method for scalar variable snmpEngineTime. The number of seconds since the value of the snmpEngineBoots object last changed. When incrementing this object's value would cause it to exceed its maximum, snmpEngineBoots is incremented as if a re-initialization had occurred, and this object's value consequently reverts to zero.
ReadSnmpPortNumer

Get method for scalar variable snmpPortNumer. Port number used by the SNMP agent to listen manager requests.
ReadSnmpSnmpGrpCntrsEnableAuthenTraps

Get method for (table) column snmpGrpCntrsEnableAuthenTraps.
ReadSnmpSnmpGrpCntrsInASNParseErrs

Get method for (table) column snmpGrpCntrsInASNParseErrs.
ReadSnmpSnmpGrpCntrsInBadCommunityNames

Get method for (table) column snmpGrpCntrsInBadCommunityNames.
ReadSnmpSnmpGrpCntrsInBadCommunityUses

Get method for (table) column snmpGrpCntrsInBadCommunityUses.
ReadSnmpSnmpGrpCntrsInBadValues

Get method for (table) column snmpGrpCntrsInBadValues.
ReadSnmpSnmpGrpCntrsInBadVersions

Get method for (table) column snmpGrpCntrsInBadVersions.
ReadSnmpSnmpGrpCntrsInGenErrs

Get method for (table) column snmpGrpCntrsInGenErrs.
ReadSnmpSnmpGrpCntrsInGetNexts

Get method for (table) column snmpGrpCntrsInGetNexts.
ReadSnmpSnmpGrpCntrsInGetRequests

Get method for (table) column snmpGrpCntrsInGetRequests.
ReadSnmpSnmpGrpCntrsInGetResponses

Get method for (table) column snmpGrpCntrsInGetResponses.
ReadSnmpSnmpGrpCntrsInNoSuchNames

Get method for (table) column snmpGrpCntrsInNoSuchNames.
ReadSnmpSnmpGrpCntrsInPkts

Get method for (table) column snmpGrpCntrsInPkts.
ReadSnmpSnmpGrpCntrsInReadOnlys

Get method for (table) column snmpGrpCntrsInReadOnlys.
ReadSnmpSnmpGrpCntrsInSetRequests

Get method for (table) column snmpGrpCntrsInSetRequests.
ReadSnmpSnmpGrpCntrsInTooBigs

Get method for (table) column snmpGrpCntrsInTooBigs.
ReadSnmpSnmpGrpCntrsInTotalReqVars

Get method for (table) column snmpGrpCntrsInTotalReqVars.
ReadSnmpSnmpGrpCntrsInTotalSetVars

Get method for (table) column snmpGrpCntrsInTotalSetVars.
ReadSnmpSnmpGrpCntrsInTraps

Get method for (table) column snmpGrpCntrsInTraps.
ReadSnmpSnmpGrpCntrsOutBadValues

Get method for (table) column snmpGrpCntrsOutBadValues.
ReadSnmpSnmpGrpCntrsOutGenErrs

Get method for (table) column snmpGrpCntrsOutGenErrs.
ReadSnmpSnmpGrpCntrsOutGetNexts

Get method for (table) column snmpGrpCntrsOutGetNexts.
ReadSnmpSnmpGrpCntrsOutGetRequests

Get method for (table) column snmpGrpCntrsOutGetRequests.
ReadSnmpSnmpGrpCntrsOutGetResponses

Get method for (table) column snmpGrpCntrsOutGetResponses.
ReadSnmpSnmpGrpCntrsOutNoSuchNames

Get method for (table) column snmpGrpCntrsOutNoSuchNames.
ReadSnmpSnmpGrpCntrsOutPkts

Get method for (table) column snmpGrpCntrsOutPkts.
ReadSnmpSnmpGrpCntrsOutSetRequests

Get method for (table) column snmpGrpCntrsOutSetRequests.
ReadSnmpSnmpGrpCntrsOutTooBigs

Get method for (table) column snmpGrpCntrsOutTooBigs.
ReadSnmpSnmpGrpCntrsOutTraps

Get method for (table) column snmpGrpCntrsOutTraps.
ReadSnmpSnmpGrpCntrsProxyDrops

Get method for scalar variable snmpProxyDrops.
ReadSnmpSnmpGrpCntrsSilentDrops

Get method for scalar variable snmpSilentDrops.
ReadSnmpSnmpSetSerialNo

Get method for scalar variable snmpSetSerialNo. An advisory lock used to allow several cooperating SNMPv2 entities, all acting in a manager role, to coordinate their use of the SNMPv2 set operation. This object is used for coarse-grain coordination. To achieve fine-grain coordination, one or more similar objects might be defined within each MIB group, as appropriate.
ReadSnmpSysContact

Get method for scalar variable sysContact. The textual identification of the contact person for this managed node, together with information on how to contact this person. If no contact information is known, the value is the zero-length string.
ReadSnmpSysDescr

Get method for scalar variable sysDescr. A textual description of the entity. This value should include the full name and version identification of the system's hardware type, software operating-system, and networking software.
ReadSnmpSysLocation

Get method for scalar variable sysLocation. The physical location of this node (e.g., `telephone closet, 3rd floor'). If the location is unknown, the value is the zero-length string.
ReadSnmpSysName

Get method for scalar variable sysName. An administratively-assigned name for this managed node. By convention, this is the node's fully-qualified domain name. If the name is unknown, the value is the zero-length string.
ReadSnmpSysORLastChange

Get method for scalar variable sysORLastChange. The value of sysUpTime at the time of the most recent change in state or value of any instance of sysORID.
ReadSnmpSysObjectID

Get method for scalar variable sysObjectID. The vendor's authoritative identification of the network management subsystem contained in the entity. This value is allocated within the SMI enterprises subtree (1.3.6.1.4.1) and provides an easy and unambiguous means for determining `what kind of box' is being managed. For example, if vendor `Flintstones, Inc.' was assigned the subtree 1.3.6.1.4.1.4242, it could assign the identifier 1.3.6.1.4.1.4242.1.1 to its `Fred Router'.
ReadSnmpSysOrDescr

Get method for (table) column sysORDescr.
ReadSnmpSysOrID

Get method for (table) column sysORID.
ReadSnmpSysOrUpTime

Get method for (table) column sysORUpTime.
ReadSnmpSysServices

Get method for scalar variable sysServices. A value which indicates the set of services that this entity may potentially offers. The value is a sum. This sum initially takes the value zero, Then, for each layer, L, in the range 1 through 7, that this node performs transactions for, 2 raised to (L - 1) is added to the sum. For example, a node which performs only routing functions would have a value of 4 (2^(3-1)). In contrast, a node which is a host offering application services would have a value of 72 (2^(4-1) + 2^(7-1)). Note that in the context of the Internet suite of protocols, values should be calculated accordingly: layer functionality 1 physical (e.g., repeaters) 2 datalink/subnetwork (e.g., bridges) 3 internet (e.g., supports the IP) 4 end-to-end (e.g., supports the TCP) 7 applications (e.g., supports the SMTP) For systems including OSI protocols, layers 5 and 6 may also be counted.
ReadSnmpSysUpTime

Get method for scalar variable sysUpTime. The time (in hundredths of a second) since the network management portion of the system was last re-initialized.
ReadSnmpUpTime

Get method for scalar variable snmpUpTime. SNMP agent (Adapter) up time.
ReadSnmpUsmUserAuthKeyChange

Get method for (table) column usmUserAuthKeyChange.
ReadSnmpUsmUserAuthProtocol

Get method for (table) column usmUserAuthProtocol.
ReadSnmpUsmUserCloneFrom

Get method for (table) column usmUserCloneFrom.
ReadSnmpUsmUserOwnAuthKeyChange

Get method for (table) column usmUserOwnAuthKeyChange.
ReadSnmpUsmUserOwnPrivKeyChange

Get method for (table) column usmUserOwnPrivKeyChange.
ReadSnmpUsmUserPrivKeyChange

Get method for (table) column usmUserPrivKeyChange.
ReadSnmpUsmUserPrivProtocol

Get method for (table) column usmUserPrivProtocol.
ReadSnmpUsmUserPublic

Get method for (table) column usmUserPublic.
ReadSnmpUsmUserSecurityName

Get method for (table) column usmUserSecurityName.
ReadSnmpUsmUserStatus

Get method for (table) column usmUserStatus.
ReadSnmpUsmUserStorageType

Get method for (table) column usmUserStorageType.
ReadSnmpVacmAccessContextMatch

Get method for (table) column snmpVacmAccessContextMatch. If the value of this object is exact(1), then all rows where the contextName exactly matches snmpVacmAccessContextPrefix are selected. If the value of this object is prefix(2), then all rows where the contextName whose starting octets exactly match snmpVacmAccessContextPrefix are selected. This allows for a simple form of wildcarding.
ReadSnmpVacmAccessNotifyViewName

Get method for (table) column snmpVacmAccessNotifyViewName. The value of an instance of this object identifies the MIB view of the SNMP context to which this conceptual row authorizes access for notifications. The identified MIB view is that one for which the vacmViewTreeFamilyViewName has the same value as the instance of this object; if the value is the empty string or if there is no active MIB view having this value of vacmViewTreeFamilyViewName, then no access is granted.
ReadSnmpVacmAccessReadViewName

Get method for (table) column snmpVacmAccessReadViewName. The value of an instance of this object identifies the MIB view of the SNMP context to which this conceptual row authorizes read access. The identified MIB view is that one for which the vacmViewTreeFamilyViewName has the same value as the instance of this object; if the value is the empty string or if there is no active MIB view having this value of vacmViewTreeFamilyViewName, then no access is granted.
ReadSnmpVacmAccessStatus

Get method for (table) column snmpVacmAccessStatus. The status of this conceptual row. The RowStatus TC [RFC 2579] requires that this DESCRIPTION clause states under which circumstances other objects in this row can be modified: The value of this object has no effect on whether other objects in this conceptual row can be modified.
ReadSnmpVacmAccessStorageType

Get method for (table) column snmpVacmAccessStorageType. The storage type for this conceptual row. Conceptual rows having the value 'permanent' need not allow write-access to any columnar objects in the row.
ReadSnmpVacmAccessWriteViewName

Get method for (table) column snmpVacmAccessWriteViewName. The value of an instance of this object identifies the MIB view of the SNMP context to which this conceptual row authorizes write access. The identified MIB view is that one for which the vacmViewTreeFamilyViewName has the same value as the instance of this object; if the value is the empty string or if there is no active MIB view having this value of vacmViewTreeFamilyViewName, then no access is granted.
ReadSnmpVacmContextName

Get method for (table) column snmpVacmContextName. A human readable name identifying a particular context at a particular SNMP entity. The empty contextName (zero length) represents the default context.
ReadSnmpVacmSecurityToGroupStatus

Get method for (table) column snmpVacmSecurityToGroupStatus.
ReadSnmpVacmSecurityToGroupStorageType

Get method for (table) column snmpVacmSecurityToGroupStorageType.
ReadSnmpVacmViewTreeFamilyMask

Get method for (table) column snmpVacmViewTreeFamilyMask.
ReadSnmpVacmViewTreeFamilyStatus

Get method for (table) column snmpVacmViewTreeFamilyStatus.
ReadSnmpVacmViewTreeFamilyStorageType

Get method for (table) column snmpVacmViewTreeFamilyStorageType.
ReadSnmpVacmViewTreeFamilyType

Get method for (table) column snmpVacmViewTreeFamilyType.
ReadSnmpVersion

Get method for scalar variable snmpVersion. Supported SNMP version. The possible values are SNMPv1, SNMPv2c and SNMPv3.
ReadSnmpv3InvalidMsgs

Get method for scalar variable snmpInvalidMsgs. The total number of packets received by the SNMP engine which were dropped because there were invalid or inconsistent components in the SNMP message.
ReadSnmpv3UnknownPDUHandlers

Get method for scalar variable snmpUnknownPDUHandlers. The total number of packets received by the SNMP engine which were dropped because the PDU contained in the packet could not be passed to an application responsible for handling the pduType, e.g. no SNMP application had registered for the proper combination of the contextEngineID and the pduType.
ReadSnmpv3UnknownSecurityModels

Get method for scalar variable snmpUnknownSecurityModels. The total number of packets received by the SNMP engine which were dropped because they referenced a securityModel that was not known to or supported by the SNMP engine.
ReadStringFromBuffer

Format the input string into CLIScroll.
ReadStringFromFile

It will read the string from the file and copies it to the destination string.
ReadStringFromFileUsingDelimiter

It will read the string from the file and copies it to the destination string.
ReadTCPMessage

Reveives input message from client.
ReadTimeOut

Read method for (table) column timeOut.
ReadUDPMessage

It reads UDP message from the client and returns client details as client socket.
ReadUdpPacket

It will read the data from the specified socket.
ReadUsmParamsDecryptionErrors

Get method for scalar variable usmStatsDecryptionErrors. The total number of packets received by the SNMP engine which were dropped because they could not be decrypted.
ReadUsmParamsNotInTimeWindows

Get method for scalar variable usmStatsNotInTimeWindows. The total number of packets received by the SNMP engine which were dropped because they appeared outside of the authoritative SNMP engine's window.
ReadUsmParamsUnknownEngineIDs

Get method for scalar variable usmStatsUnknownEngineIDs. The total number of packets received by the SNMP engine which were dropped because they referenced an snmpEngineID that was not known to the SNMP engine.
ReadUsmParamsUnknownUserNames

Get method for scalar variable usmStatsUnknownUserNames. The total number of packets received by the SNMP engine which were dropped because they referenced a user that was not known to the SNMP engine.
ReadUsmParamsUnsupportedSecLevels

Get method for scalar variable usmStatsUnsupportedSecLevels. The total number of packets received by the SNMP engine which were dropped because they requested a securityLevel that was unknown to the SNMP engine or otherwise unavailable.
ReadUsmParamsWrongDigests

Get method for scalar variable usmStatsWrongDigests. The total number of packets received by the SNMP engine which were dropped because they didn't contain the expected digest value.
ReadUsmUserSpinLock

Get method for (table) column usmUserSpinLock.
ReadVacmGroupName

Get method for (table) column vacmGroupName.
ReadVacmViewSpinLock

Get method for (table) column vacmViewSpinLock.
ReaduserName

Read method for (table) column userName.
ReallocateAndSetOID

It will free the reserved memory for dest oid and reallocate memory for the dest oid & copy the src oid.
ReallocateAndSetString

It will free the reserved memory for dest string and reallocate memory for the dest string & copy the src string.
ReceiveAndProcessProxyResponse

This function will check for proxy status and wait for proxy response and recieve the packets from rcvdQueue.
ReceiveCompleteMessage

It will receive the message untill the message is complete.
ReceiveMessage

It will receive the message and updates the status of each session.
ReceiveTcpMessage

Receive a tcp message from the client.
RecvAndProcessClientRequest

This function will check for the state of each client and process them if they are still to be pending.
RecvProcessAndSendTcpMsg

It will do the processes like receiving, processing and sending.
RegisterAcl

This function will do the functionality of registering the Acl entry in the subagent dynamically. This function will take the manager table column values as arguments, creates the Snmp PDU and finally process the Snmp PDU and return either SUCCESS or FAILURE depends on the manager entry is registered or not.
RegisterCLICommand

Registers CLI command.
RegisterListenerBeforeRestartSnmpService

This method will register a method which will be excecuted before restarting the snmp service.
RegisterManager

This function will do the functionality of registering the manager entry in the subagent dynamically. This function will take the manager table column values as arguments, creates the Snmp PDU and finally process the Snmp PDU and return either SUCCESS or FAILURE depends on the manager entry is registered or not.
RegisterModuleInfo

This function is used to register a listener in the Agent Server. After successful registration the registered module can be managed from the remote through adpators. Also it will send REGISTRATION notification to all its listeners.
RegisterNotificationListener

It will register a notification listener in notification listener table.
RegisterOID

This function will register the given OID in the tree.
RegisterSubagent

This function will do the functionality of registering the subagent dynamically, when the master agent is running. This function will take the proxy table column values as argumants, creates the Snmp PDU and finally process the Snmp PDU and return either SUCCESS or failure depends on the subagent is registered or not.
RegisterTrapReceiver

This function will do the functionality of registering the trap receiver entry in the subagent dynamically. This function will take the manager table column values as arguments, creates the Snmp PDU and finally process the Snmp PDU and return either SUCCESS or FAILURE depends on the manager entry is registered or not.
RegisterURL

This function registers a URL as a servlet with the agent * with its corresponding GET and POST Methods.
RemoveAgentServerNotificationListener

This function will delete an Entry in the gv_serverNotifListenerTable with the given listener, handler and handback which is already registered using AddAgentServerNotificationListener() method. If deregistration is success then the next notification won't be send to this listener.
RemoveAllTimerServiceNotifications

It will delete all registered TimerService notifications.
RemoveControlM

Removes control m characters if any in the given String.
RemoveCounterMonitorNotificationListener

It will unregister the given listener and handback from given table.
RemoveCounterMonitorTable

It will free all the resources allocated for the creation of a counter monitor table and removes all the listeners registered with it.
RemoveGaugeMonitorNotificationListener

It will unregister the given listener and handback from the given table.
RemoveGaugeMonitorTable

It will free all the resources allocated for the creation of a gauge monitor table and removes all the listeners registered with it.
RemoveNotifListener

It will deregister the given listener from the notification listener table. If listener is not registered then return error.
RemoveNotificationListener

It will deregister the given listener with handback from the "ObjectName's" notification listeners table, if the "ObjectName" is notification broadcaster otherwise the function call has no effect.
RemoveSnmpPktHeaderLength

It will skip the header length and return the pointer on which original data starts.
RemoveStringMonitorNotificationListener

It will unregister the given listener and handback from the given table.
RemoveStringMonitorTable

It will free all the resources allocated for the creation of a string monitor table and removes all the listeners registered with it.
RemoveTimerServiceNotifListenerTable

It will remove all the listeners from gv_timerServiceNotifListenerTable.
RemoveTimerServiceNotification

It will delete the notification corresponding to the given id if present.
RemoveTimerServiceNotificationById

It will delete the notification corresponding to the given id if present.
RemoveTimerServiceNotificationListener

It will unregister the given listener and handback from gv_timerServiceNotifListenerTable.
RemoveTimerServiceNotificationsByType

It will delete all notifications corresponding to the given type if present.
ResetIfAnyErrorOccur

This function will check if any error accur during set and do reset if it is so.
ResponseCLIMsgInfo

In this function user can do anything on the response information.
ResponseHttpMsgInfo

In this function user can do anything on the response information.
ResponseSnmpMsgInfo

In this function user can do anything on the response information.
ResponseTL1MsgInfo

In this function user can do anything on the response information.
RestartSnmpAgentService

This method will stop the already running service and restart the service for specified port.
RetreiveDA

Retreives the list of pending Delay activation input messages which meet the given input criteria.
RetreiveUserEntryDetails

retreive User entry details.
RootAdminMRAction

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.
RootAdminMRAction

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.
RootAdminMIFormatAndSendString

Format the Response String.
RootAdminMProcessRequests

This method will be called from the agent api for all the requests (READ/READ-WRITEGET) with received command value before processing the action method. The purpose of this method call is, the user can know the values 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.
RootAdminMRFormatAndSendString

Format the Response String.
RootAdminProcessRequests

This method will be called from the agent api for all the requests (READ/READ-WRITEGET) with received command value before processing the action method. The purpose of this method call is, the user can know the values 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.
RtrvAuditAction

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

It formats output text block according to the specified format type .
RtrvCidAction

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.
RtrvCmdAction

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

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.
RtrvEocreAction

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.
RtrvRscSecuAction

This method will be called by TL1 Engine upon receiving the the rtrv-rsc input command. This function initializes the AID and message payload structure variables using the values from received input message AID.
RtrvSecuAction

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.
RtrvTcpreAck

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.
RtrvTcpreAction

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.
RtrvnotifAction

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.
RtrvnotifUsage

This function will be called when rtrvnotif 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.