SNMPTrapMgr Class

Properties   Methods   Events   Config Settings   Errors  

The SNMPTrapMgr class provides a UDP-based listening point for SNMP traps.

Syntax

SNMPTrapMgr

Remarks

The SNMPTrapMgr class provides a UDP-based listening point for SNMP traps and informs as specified by the SNMP RFCs. The class supports v1, v2c, and v3 traps.

The class provides both encoding/decoding and transport capabilities, making the task of developing a custom SNMP Trap manager as simple as setting a few key properties and handling a few events. SNMP data, such as for instance SNMP object id-s (OID-s) are exchanged as text strings, thus further simplifying the task of handling them.

The class is activated/deactivated by calling the Activate or Deactivate method. These methods enable or disable sending and receiving. The activation status can be found in the Active property.

Messages are received through events such as Trap, InformRequest, or DiscoveryRequest.

SNMP OIDs, types, and values are provided in the Objects collection of SNMP objects for both sent and received packets.

SNMPv3 USM security passwords are requested through the GetUserPassword event, and event parameters such as User and SecurityLevel provide information about the security attributes of received requests, and enable granular decision capability about what to provide and what not to provide.

The AddUser, RemoveUser, ShowCache, ClearCache, AddEngine, and RemoveEngine methods are used to manage an internal authentication cache. This internal cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AcceptData Property (SNMPTrapMgr Class)

Enables or disables data reception.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAcceptData();
int SetAcceptData(int bAcceptData);

Unicode (Windows)
BOOL GetAcceptData();
INT SetAcceptData(BOOL bAcceptData);

int ipworkssnmp_snmptrapmgr_getacceptdata(void* lpObj);
int ipworkssnmp_snmptrapmgr_setacceptdata(void* lpObj, int bAcceptData);

bool GetAcceptData();
int SetAcceptData(bool bAcceptData);

Default Value

TRUE

Remarks

Setting the property to False temporarily disables data reception. Setting the property to True re-enables data reception.

This property is not available at design time.

Data Type

Boolean

Active Property (SNMPTrapMgr Class)

Indicates whether the class is active.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetActive();
int SetActive(int bActive);

Unicode (Windows)
BOOL GetActive();
INT SetActive(BOOL bActive);

int ipworkssnmp_snmptrapmgr_getactive(void* lpObj);
int ipworkssnmp_snmptrapmgr_setactive(void* lpObj, int bActive);

bool GetActive();
int SetActive(bool bActive);

Default Value

FALSE

Remarks

This property indicates whether the class is currently active and can send or receive data.

The class will be automatically activated if it is not already and you attempt to perform an operation which requires the class to be active.

Note: Use the Activate or Deactivate method to control whether the class is active.

This property is not available at design time.

Data Type

Boolean

LocalEngineId Property (SNMPTrapMgr Class)

The Engine Id (for SNMPv3).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalEngineId(char* &lpLocalEngineId, int &lenLocalEngineId);
int SetLocalEngineId(const char* lpLocalEngineId, int lenLocalEngineId);

Unicode (Windows)
INT GetLocalEngineId(LPSTR &lpLocalEngineId, INT &lenLocalEngineId);
INT SetLocalEngineId(LPCSTR lpLocalEngineId, INT lenLocalEngineId);

int ipworkssnmp_snmptrapmgr_getlocalengineid(void* lpObj, char** lpLocalEngineId, int* lenLocalEngineId);
int ipworkssnmp_snmptrapmgr_setlocalengineid(void* lpObj, const char* lpLocalEngineId, int lenLocalEngineId);

QByteArray GetLocalEngineId();
int SetLocalEngineId(QByteArray qbaLocalEngineId);

Default Value

""

Remarks

This property is necessary for properly handling InformRequest packets.

Data Type

Binary String

LocalHost Property (SNMPTrapMgr Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworkssnmp_snmptrapmgr_getlocalhost(void* lpObj);
int ipworkssnmp_snmptrapmgr_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (SNMPTrapMgr Class)

The port in the local host where the class is bound to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int ipworkssnmp_snmptrapmgr_getlocalport(void* lpObj);
int ipworkssnmp_snmptrapmgr_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

162

Remarks

The LocalPort property must be set before the class is activated (Active is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

The default port is 162 (standard trap port). If that port is busy, an error will be returned, unless the ForceLocalPort configuration setting is set to False, in which case a random port will be chosen.

LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class is Active will generate an error.

Note: on macOS and iOS, root permissions are required to set LocalPort to any value below 1024.

Data Type

Integer

ObjCount Property (SNMPTrapMgr Class)

The number of records in the Obj arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetObjCount();
int SetObjCount(int iObjCount);

Unicode (Windows)
INT GetObjCount();
INT SetObjCount(INT iObjCount);

int ipworkssnmp_snmptrapmgr_getobjcount(void* lpObj);
int ipworkssnmp_snmptrapmgr_setobjcount(void* lpObj, int iObjCount);

int GetObjCount();
int SetObjCount(int iObjCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ObjId
• ObjType
• ObjTypeString
• ObjValue

The array indices start at 0 and end at ObjCount - 1.

This property is not available at design time.

Data Type

Integer

ObjType Property (SNMPTrapMgr Class)

The current object's type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetObjType(int iObjIndex);
int SetObjType(int iObjIndex, int iObjType);

Unicode (Windows)
INT GetObjType(INT iObjIndex);
INT SetObjType(INT iObjIndex, INT iObjType);

OT_INTEGER(2), 
OT_OCTET_STRING(4), 
OT_NULL(5), 
OT_OBJECT_ID(6), 
OT_IPADDRESS(64), 
OT_COUNTER_32(65), 
OT_GAUGE_32(66), 
OT_TIME_TICKS(67), 
OT_OPAQUE(68), 
OT_NSAP(69), 
OT_COUNTER_64(70), 
OT_UNSIGNED_INTEGER_32(71), 
OT_NO_SUCH_OBJECT(128), 
OT_NO_SUCH_INSTANCE(129), 
OT_END_OF_MIB_VIEW(130)

int ipworkssnmp_snmptrapmgr_getobjtype(void* lpObj, int objindex);
int ipworkssnmp_snmptrapmgr_setobjtype(void* lpObj, int objindex, int iObjType);

int GetObjType(int iObjIndex);
int SetObjType(int iObjIndex, int iObjType);

Default Value

5

Remarks

The current object's type. The default type is NULL (5).

The corresponding object id and value are specified by the ObjOid and ObjValue properties.

Possible object type values include:

The class also supports the following artificial object values used to designate error conditions:

The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.

This property is not available at design time.

Data Type

Integer

ObjId Property (SNMPTrapMgr Class)

The current object's id which is encoded as a string of numbers separated by periods.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObjId(int iObjIndex);
int SetObjId(int iObjIndex, const char* lpszObjId);

Unicode (Windows)
LPWSTR GetObjId(INT iObjIndex);
INT SetObjId(INT iObjIndex, LPCWSTR lpszObjId);

char* ipworkssnmp_snmptrapmgr_getobjid(void* lpObj, int objindex);
int ipworkssnmp_snmptrapmgr_setobjid(void* lpObj, int objindex, const char* lpszObjId);

QString GetObjId(int iObjIndex);
int SetObjId(int iObjIndex, QString qsObjId);

Default Value

""

Remarks

The current object's id which is encoded as a string of numbers separated by periods. For instance: "1.3.6.1.2.1.1.1.0" (OID for "system description").

The corresponding object type and value (if any) are specified by the ObjectType and ObjValue properties.

Example

SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0"

The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.

This property is not available at design time.

Data Type

String

ObjTypeString Property (SNMPTrapMgr Class)

A string representation of the current object's ObjectType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObjTypeString(int iObjIndex);

Unicode (Windows)
LPWSTR GetObjTypeString(INT iObjIndex);

char* ipworkssnmp_snmptrapmgr_getobjtypestring(void* lpObj, int objindex);

QString GetObjTypeString(int iObjIndex);

Default Value

""

Remarks

A string representation of the current object's ObjectType.

The corresponding object id and value are specified by the ObjOid and ObjValue properties.

The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.

This property is read-only and not available at design time.

Data Type

String

ObjValue Property (SNMPTrapMgr Class)

The current object's value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetObjValue(int iObjIndex, char* &lpObjValue, int &lenObjValue);
int SetObjValue(int iObjIndex, const char* lpObjValue, int lenObjValue);

Unicode (Windows)
INT GetObjValue(INT iObjIndex, LPSTR &lpObjValue, INT &lenObjValue);
INT SetObjValue(INT iObjIndex, LPCSTR lpObjValue, INT lenObjValue);

int ipworkssnmp_snmptrapmgr_getobjvalue(void* lpObj, int objindex, char** lpObjValue, int* lenObjValue);
int ipworkssnmp_snmptrapmgr_setobjvalue(void* lpObj, int objindex, const char* lpObjValue, int lenObjValue);

QByteArray GetObjValue(int iObjIndex);
int SetObjValue(int iObjIndex, QByteArray qbaObjValue);

Default Value

""

Remarks

The current object's value. The corresponding object id and type are specified by the ObjOid and ObjectType properties.

Example

SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjValue(0) = "New Value"

The ObjIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjCount property.

This property is not available at design time.

Data Type

Binary String

RequestId Property (SNMPTrapMgr Class)

The request-id to mark outgoing packets with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequestId();
int SetRequestId(int iRequestId);

Unicode (Windows)
INT GetRequestId();
INT SetRequestId(INT iRequestId);

int ipworkssnmp_snmptrapmgr_getrequestid(void* lpObj);
int ipworkssnmp_snmptrapmgr_setrequestid(void* lpObj, int iRequestId);

int GetRequestId();
int SetRequestId(int iRequestId);

Default Value

1

Remarks

If a custom value is needed for RequestId, the property must be set before sending the request. The class increments RequestId automatically after sending each packet.

This property is not available at design time.

Data Type

Integer

Activate Method (SNMPTrapMgr Class)

Activates the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Activate();

Unicode (Windows)
INT Activate();

int ipworkssnmp_snmptrapmgr_activate(void* lpObj);

int Activate();

Remarks

This method activates the component and will allow it to send or receive data.

The class will be automatically activated if it is not already and you attempt to perform an operation which requires the class to be active.

Note: Use the Active property to check whether the component is active.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddEngine Method (SNMPTrapMgr Class)

Adds the engine specified by EngineId to the internal authentication cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddEngine(const char* lpEngineId, int lenEngineId, int iEngineBoots, int iEngineTime);

Unicode (Windows)
INT AddEngine(LPCSTR lpEngineId, INT lenEngineId, INT iEngineBoots, INT iEngineTime);

int ipworkssnmp_snmptrapmgr_addengine(void* lpObj, const char* lpEngineId, int lenEngineId, int iEngineBoots, int iEngineTime);

int AddEngine(QByteArray qbaEngineId, int iEngineBoots, int iEngineTime);

Remarks

The internal authentication cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.

The ShowCache method is used to show the contents of the internal authentication cache.

The ClearCache method can be used to completely clear the cache.

If the engine parameters are unknown, the SNMPMgr class's Discover method can be used to perform a discovery with the agent. The RemoteEngineId, RemoteEngineTime, and RemoteEngineBoots properties will hold the values that can then be passed to this method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddUser Method (SNMPTrapMgr Class)

Adds a user for the engine specified by EngineId to the internal authentication cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddUser(const char* lpszUser, const char* lpEngineId, int lenEngineId, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);

Unicode (Windows)
INT AddUser(LPCWSTR lpszUser, LPCSTR lpEngineId, INT lenEngineId, INT iAuthenticationProtocol, LPCWSTR lpszAuthenticationPassword, INT iEncryptionAlgorithm, LPCWSTR lpszEncryptionPassword);

int ipworkssnmp_snmptrapmgr_adduser(void* lpObj, const char* lpszUser, const char* lpEngineId, int lenEngineId, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);

int AddUser(const QString& qsUser, QByteArray qbaEngineId, int iAuthenticationProtocol, const QString& qsAuthenticationPassword, int iEncryptionAlgorithm, const QString& qsEncryptionPassword);

Remarks

The internal authentication cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.

The ShowCache method is used to show the contents of the internal authentication cache.

The ClearCache method can be used to completely clear the cache.

Valid Authentication Protocols are:

Valid Encryption Algorithms are:

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ClearCache Method (SNMPTrapMgr Class)

Clears the internal authentication database.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ClearCache();

Unicode (Windows)
INT ClearCache();

int ipworkssnmp_snmptrapmgr_clearcache(void* lpObj);

int ClearCache();

Remarks

All user and engine records are removed from the internal authentication cache as a result of this call.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (SNMPTrapMgr Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworkssnmp_snmptrapmgr_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Deactivate Method (SNMPTrapMgr Class)

Deactivates the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Deactivate();

Unicode (Windows)
INT Deactivate();

int ipworkssnmp_snmptrapmgr_deactivate(void* lpObj);

int Deactivate();

Remarks

This method deactivates the component and will prohibit it from sending and receiving data.

Note: Use the Active property to check whether the component is active.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (SNMPTrapMgr Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworkssnmp_snmptrapmgr_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

HashPasswords Method (SNMPTrapMgr Class)

Hashes all passwords in the cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int HashPasswords();

Unicode (Windows)
INT HashPasswords();

int ipworkssnmp_snmptrapmgr_hashpasswords(void* lpObj);

int HashPasswords();

Remarks

Forces computation of all passwords hashes in the cache. Used together with the HashPassword event to enable implementations of external password hash storage.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RemoveEngine Method (SNMPTrapMgr Class)

Removes the engine specified by EngineId from the internal authentication cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveEngine(const char* lpEngineId, int lenEngineId);

Unicode (Windows)
INT RemoveEngine(LPCSTR lpEngineId, INT lenEngineId);

int ipworkssnmp_snmptrapmgr_removeengine(void* lpObj, const char* lpEngineId, int lenEngineId);

int RemoveEngine(QByteArray qbaEngineId);

Remarks

The internal authentication cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.

The ShowCache method is used to show the contents of the internal authentication cache.

The ClearCache method can be used to completely clear the cache.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RemoveUser Method (SNMPTrapMgr Class)

Removes the user specified by User of the engine specified by EngineId from the internal authentication cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveUser(const char* lpszUser, const char* lpEngineId, int lenEngineId);

Unicode (Windows)
INT RemoveUser(LPCWSTR lpszUser, LPCSTR lpEngineId, INT lenEngineId);

int ipworkssnmp_snmptrapmgr_removeuser(void* lpObj, const char* lpszUser, const char* lpEngineId, int lenEngineId);

int RemoveUser(const QString& qsUser, QByteArray qbaEngineId);

Remarks

The internal authentication cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.

The ShowCache method is used to show the contents of the internal authentication cache.

The ClearCache method can be used to completely clear the cache.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (SNMPTrapMgr Class)

Clears the object arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworkssnmp_snmptrapmgr_reset(void* lpObj);

int Reset();

Remarks

Clears the object arrays, and sets the trap and error properties to their default values. This is useful for reinitializing all the properties that are used to create outgoing packets before building a new packet.

Note: SNMPVersion will be reset to snmpverV2c (2).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ShowCache Method (SNMPTrapMgr Class)

Lists all entries in the internal user and engine database.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ShowCache();

Unicode (Windows)
INT ShowCache();

int ipworkssnmp_snmptrapmgr_showcache(void* lpObj);

int ShowCache();

Remarks

A CacheEntry event is fired for every record in the database.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Value Method (SNMPTrapMgr Class)

Returns the value corresponding to an OID.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Value(const char* lpszOID);

Unicode (Windows)
LPWSTR Value(LPCWSTR lpszOID);

char* ipworkssnmp_snmptrapmgr_value(void* lpObj, const char* lpszOID);

QString Value(const QString& qsOID);

Remarks

If the OID does not exist in the Objects collection, a trappable error is generated.

Please refer to the SNMPObject type for more information.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

BadPacket Event (SNMPTrapMgr Class)

Fired for erroneous and/or malformed messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireBadPacket(SNMPTrapMgrBadPacketEventParams *e);

typedef struct {
  const char *Packet;
  int lenPacket;
  const char *SourceAddress;
  int SourcePort;
  int ErrorCode;
  const char *ErrorDescription;
  int Report;
  int reserved;
} SNMPTrapMgrBadPacketEventParams;


Unicode (Windows)
virtual INT FireBadPacket(SNMPTrapMgrBadPacketEventParams *e);

typedef struct {
  LPCSTR Packet;
  INT lenPacket;
  LPCWSTR SourceAddress;
  INT SourcePort;
  INT ErrorCode;
  LPCWSTR ErrorDescription;
  BOOL Report;
  INT reserved;
} SNMPTrapMgrBadPacketEventParams;

#define EID_SNMPTRAPMGR_BADPACKET 1

virtual INT IPWORKSSNMP_CALL FireBadPacket(LPSTR &lpPacket, INT &lenPacket, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iErrorCode, LPSTR &lpszErrorDescription, BOOL &bReport);

class SNMPTrapMgrBadPacketEventParams {
public:
  const QByteArray &Packet();

  const QString &SourceAddress();

  int SourcePort();

  int ErrorCode();

  const QString &ErrorDescription();

  bool Report();
  void SetReport(bool bReport);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void BadPacket(SNMPTrapMgrBadPacketEventParams *e);

// Or, subclass SNMPTrapMgr and override this emitter function.
virtual int FireBadPacket(SNMPTrapMgrBadPacketEventParams *e) {...}

Remarks

The full message is provided in the Packet parameter.

The BadPacket event is also fired when authentication fails for received packets due to a bad password or other reasons.

If the Report parameter is set to True, an unauthenticated error report will be sent to the client, otherwise the packet will be silently ignored.

Please refer to the GetUserPassword event for more information concerning SNMPv3 authentication.

CacheEntry Event (SNMPTrapMgr Class)

Shows engines and users in the internal cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCacheEntry(SNMPTrapMgrCacheEntryEventParams *e);

typedef struct {
  const char *EngineId;
  int lenEngineId;
  int EngineBoots;
  int EngineTime;
  const char *User;
  const char *AuthenticationProtocol;
  const char *AuthenticationPassword;
  const char *EncryptionAlgorithm;
  const char *EncryptionPassword;
  int reserved;
} SNMPTrapMgrCacheEntryEventParams;


Unicode (Windows)
virtual INT FireCacheEntry(SNMPTrapMgrCacheEntryEventParams *e);

typedef struct {
  LPCSTR EngineId;
  INT lenEngineId;
  INT EngineBoots;
  INT EngineTime;
  LPCWSTR User;
  LPCWSTR AuthenticationProtocol;
  LPCWSTR AuthenticationPassword;
  LPCWSTR EncryptionAlgorithm;
  LPCWSTR EncryptionPassword;
  INT reserved;
} SNMPTrapMgrCacheEntryEventParams;

#define EID_SNMPTRAPMGR_CACHEENTRY 2

virtual INT IPWORKSSNMP_CALL FireCacheEntry(LPSTR &lpEngineId, INT &lenEngineId, INT &iEngineBoots, INT &iEngineTime, LPSTR &lpszUser, LPSTR &lpszAuthenticationProtocol, LPSTR &lpszAuthenticationPassword, LPSTR &lpszEncryptionAlgorithm, LPSTR &lpszEncryptionPassword);

class SNMPTrapMgrCacheEntryEventParams {
public:
  const QByteArray &EngineId();

  int EngineBoots();

  int EngineTime();

  const QString &User();

  const QString &AuthenticationProtocol();

  const QString &AuthenticationPassword();

  const QString &EncryptionAlgorithm();

  const QString &EncryptionPassword();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CacheEntry(SNMPTrapMgrCacheEntryEventParams *e);

// Or, subclass SNMPTrapMgr and override this emitter function.
virtual int FireCacheEntry(SNMPTrapMgrCacheEntryEventParams *e) {...}

Remarks

CacheEntry events are triggered by a call to ShowCache. One event is fired for each user and engine. If there are no users for a particular engine, a single event is fired with the engine information, but empty values for user information.

CheckEngine Event (SNMPTrapMgr Class)

Fired to check engine parameters (timeliness, etc.).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCheckEngine(SNMPTrapMgrCheckEngineEventParams *e);

typedef struct {
  const char *EngineId;
  int lenEngineId;
  int EngineBoots;
  int EngineTime;
  const char *User;
  int SecurityLevel;
  const char *RemoteAddress;
  int RemotePort;
  int IsNew;
  int Accept;
  int reserved;
} SNMPTrapMgrCheckEngineEventParams;


Unicode (Windows)
virtual INT FireCheckEngine(SNMPTrapMgrCheckEngineEventParams *e);

typedef struct {
  LPCSTR EngineId;
  INT lenEngineId;
  INT EngineBoots;
  INT EngineTime;
  LPCWSTR User;
  INT SecurityLevel;
  LPCWSTR RemoteAddress;
  INT RemotePort;
  BOOL IsNew;
  BOOL Accept;
  INT reserved;
} SNMPTrapMgrCheckEngineEventParams;

#define EID_SNMPTRAPMGR_CHECKENGINE 3

virtual INT IPWORKSSNMP_CALL FireCheckEngine(LPSTR &lpEngineId, INT &lenEngineId, INT &iEngineBoots, INT &iEngineTime, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszRemoteAddress, INT &iRemotePort, BOOL &bIsNew, BOOL &bAccept);

class SNMPTrapMgrCheckEngineEventParams {
public:
  const QByteArray &EngineId();

  int EngineBoots();

  int EngineTime();

  const QString &User();

  int SecurityLevel();

  const QString &RemoteAddress();

  int RemotePort();

  bool IsNew();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CheckEngine(SNMPTrapMgrCheckEngineEventParams *e);

// Or, subclass SNMPTrapMgr and override this emitter function.
virtual int FireCheckEngine(SNMPTrapMgrCheckEngineEventParams *e) {...}

Remarks

The Accept parameter determines if the engine will be accepted or not. If you set Accept to False prior to exiting the event, the processing on the message will stop and a BadPacket event will be fired.

The default value of Accept is True if and only if:

a) the engine already exists in the internal authentication cache (the IsNew parameter is False) and the timeliness has been verified;

b) the engine does not exist in the internal authentication cache (the IsNew parameter is True), but the packet has been authenticated by the class (SecurityLevel >= 1).

In all other cases, the default value for Accept is False, and you are responsible for accepting or not accepting the engine based on other considerations.

If Accept is true upon event exit, then:

a) if the engine already exists in the internal authentication cache, its time is updated to reflect the new time and the processing of the packet continues;

b) if the engine does not exist in the internal authentication cache, it is added there and if User is authenticated, the User will be added too.

DiscoveryRequest Event (SNMPTrapMgr Class)

Fired when an SNMPv3 discovery packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDiscoveryRequest(SNMPTrapMgrDiscoveryRequestEventParams *e);

typedef struct {
  const char *EngineId;
  int lenEngineId;
  int EngineBoots;
  int EngineTime;
  const char *User;
  int SecurityLevel;
  const char *SourceAddress;
  int SourcePort;
  int Respond;
  int reserved;
} SNMPTrapMgrDiscoveryRequestEventParams;


Unicode (Windows)
virtual INT FireDiscoveryRequest(SNMPTrapMgrDiscoveryRequestEventParams *e);

typedef struct {
  LPCSTR EngineId;
  INT lenEngineId;
  INT EngineBoots;
  INT EngineTime;
  LPCWSTR User;
  INT SecurityLevel;
  LPCWSTR SourceAddress;
  INT SourcePort;
  BOOL Respond;
  INT reserved;
} SNMPTrapMgrDiscoveryRequestEventParams;

#define EID_SNMPTRAPMGR_DISCOVERYREQUEST 4

virtual INT IPWORKSSNMP_CALL FireDiscoveryRequest(LPSTR &lpEngineId, INT &lenEngineId, INT &iEngineBoots, INT &iEngineTime, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, BOOL &bRespond);

class SNMPTrapMgrDiscoveryRequestEventParams {
public:
  const QByteArray &EngineId();

  int EngineBoots();

  int EngineTime();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

  bool Respond();
  void SetRespond(bool bRespond);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DiscoveryRequest(SNMPTrapMgrDiscoveryRequestEventParams *e);

// Or, subclass SNMPTrapMgr and override this emitter function.
virtual int FireDiscoveryRequest(SNMPTrapMgrDiscoveryRequestEventParams *e) {...}

Remarks

EngineId, EngineBoots, EngineTime, and User are the values received from SourceAddress.

For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.

The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.

Respond is True by default, and will automatically send a response using the value in LocalEngineId. To suppress the response, set Respond to False.

The value returned to SourceAddress for EngineBoots is always 0, and EngineTime is the number of seconds since January 1st, 1970 (GMT).

Error Event (SNMPTrapMgr Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(SNMPTrapMgrErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} SNMPTrapMgrErrorEventParams;


Unicode (Windows)
virtual INT FireError(SNMPTrapMgrErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} SNMPTrapMgrErrorEventParams;

#define EID_SNMPTRAPMGR_ERROR 5

virtual INT IPWORKSSNMP_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class SNMPTrapMgrErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(SNMPTrapMgrErrorEventParams *e);

// Or, subclass SNMPTrapMgr and override this emitter function.
virtual int FireError(SNMPTrapMgrErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

GetUserPassword Event (SNMPTrapMgr Class)

Retrieves a password associated with a user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGetUserPassword(SNMPTrapMgrGetUserPasswordEventParams *e);

typedef struct {
  int PasswordType;
  const char *User;
  const char *EngineId;
  int lenEngineId;
  char *Password;
  int Algorithm;
  int reserved;
} SNMPTrapMgrGetUserPasswordEventParams;


Unicode (Windows)
virtual INT FireGetUserPassword(SNMPTrapMgrGetUserPasswordEventParams *e);

typedef struct {
  INT PasswordType;
  LPCWSTR User;
  LPCSTR EngineId;
  INT lenEngineId;
  LPWSTR Password;
  INT Algorithm;
  INT reserved;
} SNMPTrapMgrGetUserPasswordEventParams;

#define EID_SNMPTRAPMGR_GETUSERPASSWORD 6

virtual INT IPWORKSSNMP_CALL FireGetUserPassword(INT &iPasswordType, LPSTR &lpszUser, LPSTR &lpEngineId, INT &lenEngineId, LPSTR &lpszPassword, INT &iAlgorithm);

class SNMPTrapMgrGetUserPasswordEventParams {
public:
  int PasswordType();

  const QString &User();

  const QByteArray &EngineId();

  const QString &Password();
  void SetPassword(const QString &qsPassword);

  int Algorithm();
  void SetAlgorithm(int iAlgorithm);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void GetUserPassword(SNMPTrapMgrGetUserPasswordEventParams *e);

// Or, subclass SNMPTrapMgr and override this emitter function.
virtual int FireGetUserPassword(SNMPTrapMgrGetUserPasswordEventParams *e) {...}

Remarks

The GetUserPassword event is fired after initial inspection of SNMPv3 requests.

The type of password required is provided in the PasswordType parameter: 1 for authentication, and 2 for encryption (privacy).

The password corresponding to User and EngineId must be provided in the Password parameter. If the password is valid, processing will continue to other events such as GetRequest, SetRequest, etc.

If the PasswordType parameter is 1 (authentication is used), the Algorithm parameter can be set. Possible values are:

If the password does not match the signature in the request, a BadPacket event will be fired, at which point you can decide whether to report the error to the client (see the description of the BadPacket event for more information).

If the User is invalid or unknown, set the password to empty string (default) to ignore the request. This will result in a BadPacket event being fired, at which point you can decide whether to report the error to the client or not.

GetUserSecurityLevel Event (SNMPTrapMgr Class)

Sets the security level for an incoming packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGetUserSecurityLevel(SNMPTrapMgrGetUserSecurityLevelEventParams *e);

typedef struct {
  const char *User;
  const char *EngineId;
  int lenEngineId;
  int SecurityLevel;
  int reserved;
} SNMPTrapMgrGetUserSecurityLevelEventParams;


Unicode (Windows)
virtual INT FireGetUserSecurityLevel(SNMPTrapMgrGetUserSecurityLevelEventParams *e);

typedef struct {
  LPCWSTR User;
  LPCSTR EngineId;
  INT lenEngineId;
  INT SecurityLevel;
  INT reserved;
} SNMPTrapMgrGetUserSecurityLevelEventParams;

#define EID_SNMPTRAPMGR_GETUSERSECURITYLEVEL 7

virtual INT IPWORKSSNMP_CALL FireGetUserSecurityLevel(LPSTR &lpszUser, LPSTR &lpEngineId, INT &lenEngineId, INT &iSecurityLevel);

class SNMPTrapMgrGetUserSecurityLevelEventParams {
public:
  const QString &User();

  const QByteArray &EngineId();

  int SecurityLevel();
  void SetSecurityLevel(int iSecurityLevel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void GetUserSecurityLevel(SNMPTrapMgrGetUserSecurityLevelEventParams *e);

// Or, subclass SNMPTrapMgr and override this emitter function.
virtual int FireGetUserSecurityLevel(SNMPTrapMgrGetUserSecurityLevelEventParams *e) {...}

Remarks

The GetUserSecurityLevel event is fired after the first inspection of each SNMPv3 request. The SecurityLevel parameter determines the level of security for the message.

On entry, the SecurityLevel parameter contains the default security level for User if the user is located in the internal cache, or if the User is not found in the cache, the SecurityLevel will be -1.

The value of SecurityLevel upon exiting the event, determines how the message will be processed:

HashPassword Event (SNMPTrapMgr Class)

Fired before and after a password is hashed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHashPassword(SNMPTrapMgrHashPasswordEventParams *e);

typedef struct {
  const char *Password;
  int AuthAlgorithm;
  char *Hash;
  int reserved;
} SNMPTrapMgrHashPasswordEventParams;


Unicode (Windows)
virtual INT FireHashPassword(SNMPTrapMgrHashPasswordEventParams *e);

typedef struct {
  LPCWSTR Password;
  INT AuthAlgorithm;
  LPWSTR Hash;
  INT reserved;
} SNMPTrapMgrHashPasswordEventParams;

#define EID_SNMPTRAPMGR_HASHPASSWORD 8

virtual INT IPWORKSSNMP_CALL FireHashPassword(LPSTR &lpszPassword, INT &iAuthAlgorithm, LPSTR &lpszHash);

class SNMPTrapMgrHashPasswordEventParams {
public:
  const QString &Password();

  int AuthAlgorithm();

  const QString &Hash();
  void SetHash(const QString &qsHash);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void HashPassword(SNMPTrapMgrHashPasswordEventParams *e);

// Or, subclass SNMPTrapMgr and override this emitter function.
virtual int FireHashPassword(SNMPTrapMgrHashPasswordEventParams *e) {...}

Remarks

SNMPv3 passwords are hashed in order to obtain authentication and encryption keys. This is an expensive operation, and in certain situations it may be preferable to store the hashed passwords externally and supply them on demand.

If a hash is required, the event fires with an empty string in the Hash parameter. In this case, you can choose to supply a value for the hash and stop the class from computing the hash.

The event also fires every time a hash is computed. In this case, the Hash parameter contains the value of the computed hash.

AuthAlgorithm contains either 1 for HMAC-MD5-96, 2 for HMAC-SHA-96 or 3 for HMAC-192-SHA-256

InformRequest Event (SNMPTrapMgr Class)

Fired when an InformRequest packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireInformRequest(SNMPTrapMgrInformRequestEventParams *e);

typedef struct {
  int RequestId;
  int SNMPVersion;
  const char *Community;
  const char *User;
  int SecurityLevel;
  const char *SourceAddress;
  int SourcePort;
  int ErrorIndex;
  int ErrorStatus;
  const char *ErrorDescription;
  int Respond;
  int reserved;
} SNMPTrapMgrInformRequestEventParams;


Unicode (Windows)
virtual INT FireInformRequest(SNMPTrapMgrInformRequestEventParams *e);

typedef struct {
  INT RequestId;
  INT SNMPVersion;
  LPCWSTR Community;
  LPCWSTR User;
  INT SecurityLevel;
  LPCWSTR SourceAddress;
  INT SourcePort;
  INT ErrorIndex;
  INT ErrorStatus;
  LPCWSTR ErrorDescription;
  BOOL Respond;
  INT reserved;
} SNMPTrapMgrInformRequestEventParams;

#define EID_SNMPTRAPMGR_INFORMREQUEST 9

virtual INT IPWORKSSNMP_CALL FireInformRequest(INT &iRequestId, INT &iSNMPVersion, LPSTR &lpszCommunity, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszSourceAddress, INT &iSourcePort, INT &iErrorIndex, INT &iErrorStatus, LPSTR &lpszErrorDescription, BOOL &bRespond);

class SNMPTrapMgrInformRequestEventParams {
public:
  int RequestId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

  int ErrorIndex();
  void SetErrorIndex(int iErrorIndex);

  int ErrorStatus();
  void SetErrorStatus(int iErrorStatus);

  const QString &ErrorDescription();

  bool Respond();
  void SetRespond(bool bRespond);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void InformRequest(SNMPTrapMgrInformRequestEventParams *e);

// Or, subclass SNMPTrapMgr and override this emitter function.
virtual int FireInformRequest(SNMPTrapMgrInformRequestEventParams *e) {...}

Remarks

For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.

The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.

The user in an InformRequest packet (SNMPv3) must be a valid user in the internal authentication cache (see the AddUser method and the CheckEngine event for more information). If not, the request is rejected, and a BadPacket event is fired before InformRequest is fired.

The list of variables in the SNMP packet, including optional values and types, is provided through the Objects collection. Each object is of type SNMPObject. This type describes the ObjId, ObjType, and ObjValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.

The MessageId parameter identifies the received request.

For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.

The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.

To send a response, the Respond parameter must be set to true. By default, this value is false, which means no response will be sent. The ErrorStatus parameter may also be set to a valid SNMP status code (the default value is 0, which represents no error).

The following is a list of valid SNMP status code values:

Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).

PacketTrace Event (SNMPTrapMgr Class)

Fired for every packet sent or received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePacketTrace(SNMPTrapMgrPacketTraceEventParams *e);

typedef struct {
  const char *Packet;
  int lenPacket;
  int Direction;
  const char *PacketAddress;
  int PacketPort;
  int reserved;
} SNMPTrapMgrPacketTraceEventParams;


Unicode (Windows)
virtual INT FirePacketTrace(SNMPTrapMgrPacketTraceEventParams *e);

typedef struct {
  LPCSTR Packet;
  INT lenPacket;
  INT Direction;
  LPCWSTR PacketAddress;
  INT PacketPort;
  INT reserved;
} SNMPTrapMgrPacketTraceEventParams;

#define EID_SNMPTRAPMGR_PACKETTRACE 10

virtual INT IPWORKSSNMP_CALL FirePacketTrace(LPSTR &lpPacket, INT &lenPacket, INT &iDirection, LPSTR &lpszPacketAddress, INT &iPacketPort);

class SNMPTrapMgrPacketTraceEventParams {
public:
  const QByteArray &Packet();

  int Direction();

  const QString &PacketAddress();

  int PacketPort();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PacketTrace(SNMPTrapMgrPacketTraceEventParams *e);

// Or, subclass SNMPTrapMgr and override this emitter function.
virtual int FirePacketTrace(SNMPTrapMgrPacketTraceEventParams *e) {...}

Remarks

The PacketTrace event shows all the packets sent or received by the class.

Packet contains the full contents of the datagram.

Direction shows the direction of the packet: 1 for incoming packets, and 2 for outgoing packets.

In the case of an incoming packet, PacketAddress and PacketPort identify the source of the packet.

In the case of an outgoing packet, PacketAddress and PacketPort identify the destination of the packet.

Trap Event (SNMPTrapMgr Class)

Fired when a SNMP trap packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTrap(SNMPTrapMgrTrapEventParams *e);

typedef struct {
  int RequestId;
  int SNMPVersion;
  const char *Community;
  const char *User;
  int SecurityLevel;
  const char *TrapOID;
  int64 TimeStamp;
  const char *AgentAddress;
  const char *SourceAddress;
  int SourcePort;
  int reserved;
} SNMPTrapMgrTrapEventParams;


Unicode (Windows)
virtual INT FireTrap(SNMPTrapMgrTrapEventParams *e);

typedef struct {
  INT RequestId;
  INT SNMPVersion;
  LPCWSTR Community;
  LPCWSTR User;
  INT SecurityLevel;
  LPCWSTR TrapOID;
  LONG64 TimeStamp;
  LPCWSTR AgentAddress;
  LPCWSTR SourceAddress;
  INT SourcePort;
  INT reserved;
} SNMPTrapMgrTrapEventParams;

#define EID_SNMPTRAPMGR_TRAP 11

virtual INT IPWORKSSNMP_CALL FireTrap(INT &iRequestId, INT &iSNMPVersion, LPSTR &lpszCommunity, LPSTR &lpszUser, INT &iSecurityLevel, LPSTR &lpszTrapOID, LONG64 &lTimeStamp, LPSTR &lpszAgentAddress, LPSTR &lpszSourceAddress, INT &iSourcePort);

class SNMPTrapMgrTrapEventParams {
public:
  int RequestId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &TrapOID();

  qint64 TimeStamp();

  const QString &AgentAddress();

  const QString &SourceAddress();

  int SourcePort();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Trap(SNMPTrapMgrTrapEventParams *e);

// Or, subclass SNMPTrapMgr and override this emitter function.
virtual int FireTrap(SNMPTrapMgrTrapEventParams *e) {...}

Remarks

The TrapOID and TimeStamp parameters contain the Trap OID and TimeStamp. In the case of an SNMPv1 trap, there are two possible scenarios:

First, if the enterprise of the trap is "1.3.6.1.6.3.1.1.5", TrapOID will be a concatenation of TrapEnterprise and GenericTrap + 1. For instance a TrapOID of "1.3.6.1.6.3.1.1.5.5" has a TrapEnterprise of "1.3.6.1.6.3.1.1.5" and a GenericTrap of "4".

Second, In all other cases TrapOID will be a concatenation of the values for TrapEnterprise, GenericTrap, and SpecificTrap, separated by '.'.

For SNMPv2 and above, they are read from the variable-value list (if available).

For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.

The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.

The list of variables in the SNMP packet, including optional values and types, is provided through the Objects collection. Each object is of type SNMPObject. This type describes the ObjId, ObjType, and ObjValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.

Some parameters are only applicable depending on the SNMPVersion value. The table below shows which parameters are applicable to which SNMP versions.

Config Settings (SNMPTrapMgr Class)

SNMPTrapMgr Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SNMPTrapMgr Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SNMPTrapMgr Errors

The class may also return one of the following error codes, which are inherited from other classes.

UDP Errors

SSL Errors

TCP/IP Errors