Messenger Class

Messenger class contains all static helper methods you need to send out SNMP messages. Static methods in Manager or Agent class will be removed in the future.

Inheritance Hierarchy

SystemObject
GSF.Net.Snmp.MessagingMessenger

Namespace: GSF.Net.Snmp.Messaging
Assembly: GSF.Net (in GSF.Net.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

public static class Messenger

<ExtensionAttribute>
Public NotInheritable Class Messenger

[ExtensionAttribute]
public ref class Messenger abstract sealed

[<AbstractClassAttribute>]
[<SealedAttribute>]
[<ExtensionAttribute>]
type Messenger = class end

GSF.Net.Snmp.Messaging.Messenger = function();

Type.createClass(
	'GSF.Net.Snmp.Messaging.Messenger');

View Source

The Messenger type exposes the following members.

Properties

	Name	Description
	AuthenticationFailure	If the authentication module returns failure, then the message cannot be trusted, so the usmStatsWrongDigests counter is incremented and an error indication (authenticationFailure) together with the OID and value of the incremented counter is returned to the calling module.
	DecryptionError	If the privacy module returns failure, then the message can not be processed, so the usmStatsDecryptionErrors counter is incremented and an error indication (decryptionError) together with the OID and value of the incremented counter is returned to the calling module.
	MaxMessageSize	Max message size used in #SNMP.
	NextDiscovery	Obsolete. Returns a new discovery request.
	NextMessageId	Gets the message counter.
	NextRequestId	Gets the request counter.
	NotInTimeWindow	If the message is considered to be outside of the Time Window then the usmStatsNotInTimeWindows counter is incremented and an error indication (notInTimeWindow) together with the OID, the value of the incremented counter, and an indication that the error must be reported with a securityLevel of authNoPriv, is returned to the calling module
	UnknownEngineId	If the value of the msgAuthoritativeEngineID field in the securityParameters is unknown then the usmStatsUnknownEngineIDs counter is incremented, and an error indication (unknownEngineID) together with the OID and value of the incremented counter is returned to the calling module.
	UnknownSecurityName	Information about the value of the msgUserName and msgAuthoritativeEngineID fields is extracted from the Local Configuration Datastore (LCD, usmUserTable). If no information is available for the user, then the usmStatsUnknownUserNames counter is incremented and an error indication (unknownSecurityName) together with the OID and value of the incremented counter is returned to the calling module.
	UnsupportedSecurityLevel	If the information about the user indicates that it does not support the securityLevel requested by the caller, then the usmStatsUnsupportedSecLevels counter is incremented and an error indication (unsupportedSecurityLevel) together with the OID and value of the incremented counter is returned to the calling module.
	UseFullRange	A flag to control request ID range.

Top

Methods

	Name	Description
	BulkWalk(VersionCode, IPEndPoint, OctetString, ObjectIdentifier, IListVariable, Int32, Int32, WalkMode, IPrivacyProvider, ISnmpMessage)	Obsolete. Walks (based on GET BULK).
	BulkWalk(VersionCode, IPEndPoint, OctetString, OctetString, ObjectIdentifier, IListVariable, Int32, Int32, WalkMode, IPrivacyProvider, ISnmpMessage)	Walks (based on GET BULK).
	BulkWalkAsync(VersionCode, IPEndPoint, OctetString, ObjectIdentifier, IListVariable, Int32, WalkMode, IPrivacyProvider, ISnmpMessage)	Obsolete. Walks (based on GET BULK).
	BulkWalkAsync(VersionCode, IPEndPoint, OctetString, OctetString, ObjectIdentifier, IListVariable, Int32, WalkMode, IPrivacyProvider, ISnmpMessage)	Walks (based on GET BULK).
	Get	Gets a list of variable binds.
	GetAsync	Gets a list of variable binds.
	GetErrorMessage	Returns error message for the specific ObjectIdentifier.
	GetNextDiscovery	Returns a new discovery request.
	GetTable	Obsolete. Gets a table of variables.
	SendInform(Int32, VersionCode, IPEndPoint, OctetString, ObjectIdentifier, UInt32, IListVariable, Int32, IPrivacyProvider, ISnmpMessage)	Obsolete. Sends INFORM message.
	SendInform(Int32, VersionCode, IPEndPoint, OctetString, OctetString, ObjectIdentifier, UInt32, IListVariable, Int32, IPrivacyProvider, ISnmpMessage)	Sends INFORM message.
	SendInformAsync(Int32, VersionCode, IPEndPoint, OctetString, ObjectIdentifier, UInt32, IListVariable, IPrivacyProvider, ISnmpMessage)	Obsolete. Sends INFORM message.
	SendInformAsync(Int32, VersionCode, IPEndPoint, OctetString, OctetString, ObjectIdentifier, UInt32, IListVariable, IPrivacyProvider, ISnmpMessage)	Sends INFORM message.
	SendTrapV1	Sends a TRAP v1 message.
	SendTrapV1Async	Sends a TRAP v1 message.
	SendTrapV2	Sends TRAP v2 message.
	SendTrapV2Async	Sends TRAP v2 message.
	Set	Sets a list of variable binds.
	SetAsync	Sets a list of variable binds.
	Walk	Walks (based on GET NEXT).
	WalkAsync	Walks (based on GET NEXT).

Top

Remarks

SNMP v3 is not supported in many methods of this class. Please use ISnmpMessage derived classes directly if you want to do v3 operations.

Reference

GSF.Net.Snmp.Messaging Namespace