SNMPTCPMgr Class

Properties   Methods   Events   Config Settings   Errors  

The SNMPTCPMgr class is used to implement TCP-based SNMP Management Applications.

Syntax

SNMPTCPMgr

Remarks

The SNMPTCPMgr class implements a TCP-based standard SNMP Manager as specified in the SNMP RFCs. The class supports SNMP v1, v2c, and v3.

The class provides both encoding/decoding and transport capabilities, making the task of developing a custom SNMP 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 Response, Trap, or InformRequest. SNMP Traps are received through the Trap event.

Messages are sent to other agents or managers by using class's methods such as SendGetRequest, SendGetNextRequest, SendGetBulkRequest, SendSetRequest, and SendInformRequest.

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

SNMPv3 USM security is enabled by setting properties such as User, AuthenticationPassword, and EncryptionPassword and calling the Discover method to bind to a particular agent (RemoteEngineId). Upon successful discovery, received packets are checked for integrity (authentication) and timeliness. Note that the discovery step is optional, and may be avoided if the values for RemoteEngineId, RemoteEngineBoots, and RemoteEngineTime are known in advance and provided to the class through the respective properties.

By default, the class operates synchronously (except for the Discover method), sending a request and waiting until the corresponding response has been received. This behavior may be overridden by setting Timeout to 0, in which case the class returns control immediately after a send, and responses are received exclusively through the Response event.

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 (SNMPTCPMgr 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_snmptcpmgr_getacceptdata(void* lpObj);
int ipworkssnmp_snmptcpmgr_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 (SNMPTCPMgr 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_snmptcpmgr_getactive(void* lpObj);
int ipworkssnmp_snmptcpmgr_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.

Use the Activate and Deactivate methods to control whether the class is active.

This property is not available at design time.

Data Type

Boolean

AuthenticationPassword Property (SNMPTCPMgr Class)

The password used for SNMPv3 authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthenticationPassword();
int SetAuthenticationPassword(const char* lpszAuthenticationPassword);

Unicode (Windows)
LPWSTR GetAuthenticationPassword();
INT SetAuthenticationPassword(LPCWSTR lpszAuthenticationPassword);

char* ipworkssnmp_snmptcpmgr_getauthenticationpassword(void* lpObj);
int ipworkssnmp_snmptcpmgr_setauthenticationpassword(void* lpObj, const char* lpszAuthenticationPassword);

QString GetAuthenticationPassword();
int SetAuthenticationPassword(QString qsAuthenticationPassword);

Default Value

""

Remarks

Every time EncryptionPassword, AuthenticationPassword, or RemoteEngineId are set, a localized key is computed automatically, and cached internally.

Data Type

String

AuthenticationProtocol Property (SNMPTCPMgr Class)

The authentication protocol used for SNMPv3 packets.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthenticationProtocol();
int SetAuthenticationProtocol(int iAuthenticationProtocol);

Unicode (Windows)
INT GetAuthenticationProtocol();
INT SetAuthenticationProtocol(INT iAuthenticationProtocol);

AUTHP_HMACMD596(1), 
AUTHP_HMACSHA96(2), 
AUTHP_HMAC192SHA256(3), 
AUTHP_HMAC384SHA512(4)

int ipworkssnmp_snmptcpmgr_getauthenticationprotocol(void* lpObj);
int ipworkssnmp_snmptcpmgr_setauthenticationprotocol(void* lpObj, int iAuthenticationProtocol);

int GetAuthenticationProtocol();
int SetAuthenticationProtocol(int iAuthenticationProtocol);

Default Value

1

Remarks

This property defines the authentication protocol used when SNMPVersion is set to snmpverV3. Possible values are:

• 1 (HMAC-MD5-96 - default)
• 2 (HMAC-SHA-96)
• 3 (HMAC-192-SHA-256)
• 4 (HMAC-384-SHA-512)

This property is not available at design time.

Data Type

Integer

Community Property (SNMPTCPMgr Class)

The community string used to authenticate SNMP packets.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommunity();
int SetCommunity(const char* lpszCommunity);

Unicode (Windows)
LPWSTR GetCommunity();
INT SetCommunity(LPCWSTR lpszCommunity);

char* ipworkssnmp_snmptcpmgr_getcommunity(void* lpObj);
int ipworkssnmp_snmptcpmgr_setcommunity(void* lpObj, const char* lpszCommunity);

QString GetCommunity();
int SetCommunity(QString qsCommunity);

Default Value

"public"

Remarks

Must match the community name that is specified on the agent.

Typical values are "public" or "private".

This property is used for all SNMP packets sent by the class.

Data Type

String

EncryptionAlgorithm Property (SNMPTCPMgr Class)

The encryption algorithm used for SNMPv3 packets.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Unicode (Windows)
INT GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(INT iEncryptionAlgorithm);

ENCRA_DES(1), 
ENCRA_AES(2), 
ENCRA_3DES(3), 
ENCRA_AES192(4), 
ENCRA_AES256(5)

int ipworkssnmp_snmptcpmgr_getencryptionalgorithm(void* lpObj);
int ipworkssnmp_snmptcpmgr_setencryptionalgorithm(void* lpObj, int iEncryptionAlgorithm);

int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Default Value

1

Remarks

In order to use encryption, you must set the EncryptionPassword property. The supported algorithms for encryption are:

This property is not available at design time.

Data Type

Integer

EncryptionPassword Property (SNMPTCPMgr Class)

The password used for SNMPv3 privacy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionPassword();
int SetEncryptionPassword(const char* lpszEncryptionPassword);

Unicode (Windows)
LPWSTR GetEncryptionPassword();
INT SetEncryptionPassword(LPCWSTR lpszEncryptionPassword);

char* ipworkssnmp_snmptcpmgr_getencryptionpassword(void* lpObj);
int ipworkssnmp_snmptcpmgr_setencryptionpassword(void* lpObj, const char* lpszEncryptionPassword);

QString GetEncryptionPassword();
int SetEncryptionPassword(QString qsEncryptionPassword);

Default Value

""

Remarks

Every time EncryptionPassword, AuthenticationPassword, or RemoteEngineId are set, a localized key is computed automatically, and cached internally.

Data Type

String

ErrorDescription Property (SNMPTCPMgr Class)

Description of the status code for the last SNMP packet received by the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetErrorDescription();

Unicode (Windows)
LPWSTR GetErrorDescription();

char* ipworkssnmp_snmptcpmgr_geterrordescription(void* lpObj);

QString GetErrorDescription();

Default Value

"0"

Remarks

Please refer to the ErrorStatus property for more information.

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

Data Type

String

ErrorIndex Property (SNMPTCPMgr Class)

Index of the first variable (object) that caused an error from the last SNMP response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetErrorIndex();

Unicode (Windows)
INT GetErrorIndex();

int ipworkssnmp_snmptcpmgr_geterrorindex(void* lpObj);

int GetErrorIndex();

Default Value

0

Remarks

This property is used in conjunction with the ErrorStatus property, and refers to the object that caused the error reported in the last SNMP response. This value is parsed directly from the SNMP response, which will be a one-based value, so a value of i here maps to index i-1 in the Objects collection.

The ErrorIndex property has no meaning when the ErrorStatus property is 0 (no error).

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

Data Type

Integer

ErrorStatus Property (SNMPTCPMgr Class)

Status code for the last SNMP packet received by the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetErrorStatus();

Unicode (Windows)
INT GetErrorStatus();

int ipworkssnmp_snmptcpmgr_geterrorstatus(void* lpObj);

int GetErrorStatus();

Default Value

0

Remarks

This property is used in conjunction with the ErrorIndex property, which denotes the index of the variable in error. The ErrorDescription property provides a textual description of the 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).

The default value is 0 (no error).

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

Data Type

Integer

LocalEngineId Property (SNMPTCPMgr Class)

The Engine Id of the SNMP Manager.

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_snmptcpmgr_getlocalengineid(void* lpObj, char** lpLocalEngineId, int* lenLocalEngineId);
int ipworkssnmp_snmptcpmgr_setlocalengineid(void* lpObj, const char* lpLocalEngineId, int lenLocalEngineId);

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

Default Value

""

Remarks

This property is only used for SNMPv3 packets (when SNMPVersion is 3).

Data Type

Binary String

LocalHost Property (SNMPTCPMgr 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_snmptcpmgr_getlocalhost(void* lpObj);
int ipworkssnmp_snmptcpmgr_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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 multihomed 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 (SNMPTCPMgr Class)

The port in the local host where the SNMP Manager 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_snmptcpmgr_getlocalport(void* lpObj);
int ipworkssnmp_snmptcpmgr_setlocalport(void* lpObj, int iLocalPort);

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

Default Value

0

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 0 (random port). If you would like to receive traps, set LocalPort to 162 (standard trap port). However, it is recommended that the SNMPTrapMgr class be used for listening to traps, because SNMPMgr is limited to receiving SNMPv3 traps from a single agent only. SNMPTrapMgr does not have this limitation.

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

Objects Property (SNMPTCPMgr Class)

The objects in the current request.

Syntax

• C++
• C
• Qt

IPWorksSNMPList<IPWorksSNMPSNMPObject>* GetObjects();
int SetObjects(IPWorksSNMPList<IPWorksSNMPSNMPObject>* val);

int ipworkssnmp_snmptcpmgr_getobjcount(void* lpObj);
int ipworkssnmp_snmptcpmgr_setobjcount(void* lpObj, int iObjCount);

int ipworkssnmp_snmptcpmgr_getobjtype(void* lpObj, int objindex);
int ipworkssnmp_snmptcpmgr_setobjtype(void* lpObj, int objindex, int iObjType);

char* ipworkssnmp_snmptcpmgr_getobjid(void* lpObj, int objindex);
int ipworkssnmp_snmptcpmgr_setobjid(void* lpObj, int objindex, const char* lpszObjId);

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

int ipworkssnmp_snmptcpmgr_getobjvalue(void* lpObj, int objindex, char** lpObjValue, int* lenObjValue);
int ipworkssnmp_snmptcpmgr_setobjvalue(void* lpObj, int objindex, const char* lpObjValue, int lenObjValue);

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

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

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

QString GetObjTypeString(int iObjIndex);

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

Remarks

The SNMP objects being sent or received in the current request. The collection is first cleared, then populated every time an SNMP packet is received. It is also used to create outgoing SNMP packets.

Data Type

IPWorksSNMPSNMPObject

RemoteEngineBoots Property (SNMPTCPMgr Class)

The remote engine boots (SNMPv3).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRemoteEngineBoots();
int SetRemoteEngineBoots(int iRemoteEngineBoots);

Unicode (Windows)
INT GetRemoteEngineBoots();
INT SetRemoteEngineBoots(INT iRemoteEngineBoots);

int ipworkssnmp_snmptcpmgr_getremoteengineboots(void* lpObj);
int ipworkssnmp_snmptcpmgr_setremoteengineboots(void* lpObj, int iRemoteEngineBoots);

int GetRemoteEngineBoots();
int SetRemoteEngineBoots(int iRemoteEngineBoots);

Default Value

0

Remarks

This property is used in conjunction with the RemoteEngineTime property. Please refer to the description of the RemoteEngineTime property, and the Discover method for further information.

Data Type

Integer

RemoteEngineId Property (SNMPTCPMgr Class)

The Engine Id of the remote agent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRemoteEngineId(char* &lpRemoteEngineId, int &lenRemoteEngineId);
int SetRemoteEngineId(const char* lpRemoteEngineId, int lenRemoteEngineId);

Unicode (Windows)
INT GetRemoteEngineId(LPSTR &lpRemoteEngineId, INT &lenRemoteEngineId);
INT SetRemoteEngineId(LPCSTR lpRemoteEngineId, INT lenRemoteEngineId);

int ipworkssnmp_snmptcpmgr_getremoteengineid(void* lpObj, char** lpRemoteEngineId, int* lenRemoteEngineId);
int ipworkssnmp_snmptcpmgr_setremoteengineid(void* lpObj, const char* lpRemoteEngineId, int lenRemoteEngineId);

QByteArray GetRemoteEngineId();
int SetRemoteEngineId(QByteArray qbaRemoteEngineId);

Default Value

""

Remarks

This property is only used for SNMPv3 packets (see SNMPVersion), and is reset every time RemoteHost or RemotePort changes.

RemoteEngineId is normally discovered through the Discover method. However, by manually supplying a value for the property, RemoteEngineId discovery step may be eliminated, thus avoiding the extra roundtrip to the agent (RemoteEngineBoots and RemoteEngineTime are also required for User authentication - please refer to the Discover method for more information).

Data Type

Binary String

RemoteEngineTime Property (SNMPTCPMgr Class)

The remote engine time (SNMPv3).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRemoteEngineTime();
int SetRemoteEngineTime(int iRemoteEngineTime);

Unicode (Windows)
INT GetRemoteEngineTime();
INT SetRemoteEngineTime(INT iRemoteEngineTime);

int ipworkssnmp_snmptcpmgr_getremoteenginetime(void* lpObj);
int ipworkssnmp_snmptcpmgr_setremoteenginetime(void* lpObj, int iRemoteEngineTime);

int GetRemoteEngineTime();
int SetRemoteEngineTime(int iRemoteEngineTime);

Default Value

0

Remarks

RemoteEngineTime is used by SNMPv3 authentication to ensure timeliness of requests, and avoid replay attacks.

The value of RemoteEngineTime is provided as what is expected to be the current value of the remote engine clock based on a cached time differential between the remote engine clock and the local engine time obtained during the discovery process (see Discover).

This property is used in conjunction with RemoteEngineBoots. Please refer to the RemoteEngineBoots property and the Discover method for more information.

Data Type

Integer

RemoteHost Property (SNMPTCPMgr Class)

The address of the remote host. Domain names are resolved to IP addresses.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRemoteHost();
int SetRemoteHost(const char* lpszRemoteHost);

Unicode (Windows)
LPWSTR GetRemoteHost();
INT SetRemoteHost(LPCWSTR lpszRemoteHost);

char* ipworkssnmp_snmptcpmgr_getremotehost(void* lpObj);
int ipworkssnmp_snmptcpmgr_setremotehost(void* lpObj, const char* lpszRemoteHost);

QString GetRemoteHost();
int SetRemoteHost(QString qsRemoteHost);

Default Value

""

Remarks

The RemoteHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the host SNMP requests or traps are sent to.

If RemoteHost is set to 255.255.255.255, the class broadcasts data on the local subnet.

If the RemoteHost property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the RemoteHost property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

RemotePort Property (SNMPTCPMgr Class)

The port where the remote SNMP agent is listening.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRemotePort();
int SetRemotePort(int iRemotePort);

Unicode (Windows)
INT GetRemotePort();
INT SetRemotePort(INT iRemotePort);

int ipworkssnmp_snmptcpmgr_getremoteport(void* lpObj);
int ipworkssnmp_snmptcpmgr_setremoteport(void* lpObj, int iRemotePort);

int GetRemotePort();
int SetRemotePort(int iRemotePort);

Default Value

161

Remarks

The RemotePort is the port on the RemoteHost to send SNMP requests to.

A valid port number (a value between 1 and 65535) is required. The default value is 161.

Data Type

Integer

RequestId Property (SNMPTCPMgr 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_snmptcpmgr_getrequestid(void* lpObj);
int ipworkssnmp_snmptcpmgr_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

SNMPVersion Property (SNMPTCPMgr Class)

Version of SNMP used for outgoing requests.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSNMPVersion();
int SetSNMPVersion(int iSNMPVersion);

Unicode (Windows)
INT GetSNMPVersion();
INT SetSNMPVersion(INT iSNMPVersion);

SNMPVER_V1(1), 
SNMPVER_V2C(2), 
SNMPVER_V3(3)

int ipworkssnmp_snmptcpmgr_getsnmpversion(void* lpObj);
int ipworkssnmp_snmptcpmgr_setsnmpversion(void* lpObj, int iSNMPVersion);

int GetSNMPVersion();
int SetSNMPVersion(int iSNMPVersion);

Default Value

2

Remarks

This property takes one of the following values:

Data Type

Integer

SSLAcceptServerCert Property (SNMPTCPMgr Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

IPWorksSNMPCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksSNMPCertificate* val);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertfingerprint(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertissuer(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertprivatekey(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertpublickey(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertserialnumber(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworkssnmp_snmptcpmgr_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertstorepassword(void* lpObj);
int ipworkssnmp_snmptcpmgr_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworkssnmp_snmptcpmgr_getsslacceptservercertstoretype(void* lpObj);
int ipworkssnmp_snmptcpmgr_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertusage(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslacceptservercertusageflags(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertversion(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslacceptservercertsubject(void* lpObj);
int ipworkssnmp_snmptcpmgr_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworkssnmp_snmptcpmgr_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworkssnmp_snmptcpmgr_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

IPWorksSNMPCertificate

SSLAuthenticateClients Property (SNMPTCPMgr Class)

If set to True, the server asks the client(s) for a certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(int bSSLAuthenticateClients);

Unicode (Windows)
BOOL GetSSLAuthenticateClients();
INT SetSSLAuthenticateClients(BOOL bSSLAuthenticateClients);

int ipworkssnmp_snmptcpmgr_getsslauthenticateclients(void* lpObj);
int ipworkssnmp_snmptcpmgr_setsslauthenticateclients(void* lpObj, int bSSLAuthenticateClients);

bool GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(bool bSSLAuthenticateClients);

Default Value

FALSE

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

Data Type

Boolean

SSLCert Property (SNMPTCPMgr Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorksSNMPCertificate* GetSSLCert();
int SetSSLCert(IPWorksSNMPCertificate* val);

char* ipworkssnmp_snmptcpmgr_getsslcerteffectivedate(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertexpirationdate(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertextendedkeyusage(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertfingerprint(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertfingerprintsha1(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertfingerprintsha256(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertissuer(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertprivatekey(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslcertprivatekeyavailable(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertprivatekeycontainer(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertpublickey(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertpublickeyalgorithm(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslcertpublickeylength(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertserialnumber(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertsignaturealgorithm(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworkssnmp_snmptcpmgr_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworkssnmp_snmptcpmgr_getsslcertstorepassword(void* lpObj);
int ipworkssnmp_snmptcpmgr_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworkssnmp_snmptcpmgr_getsslcertstoretype(void* lpObj);
int ipworkssnmp_snmptcpmgr_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworkssnmp_snmptcpmgr_getsslcertsubjectaltnames(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertthumbprintmd5(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertthumbprintsha1(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertthumbprintsha256(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertusage(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslcertusageflags(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertversion(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslcertsubject(void* lpObj);
int ipworkssnmp_snmptcpmgr_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworkssnmp_snmptcpmgr_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworkssnmp_snmptcpmgr_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksSNMPCertificate

SSLEnabled Property (SNMPTCPMgr Class)

Whether TLS/SSL is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);

int ipworkssnmp_snmptcpmgr_getsslenabled(void* lpObj);
int ipworkssnmp_snmptcpmgr_setsslenabled(void* lpObj, int bSSLEnabled);

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

Default Value

FALSE

Remarks

This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class operates in plaintext mode. When True TLS/SSL is enabled.

This property is not available at design time.

Data Type

Boolean

SSLServerCert Property (SNMPTCPMgr Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksSNMPCertificate* GetSSLServerCert();

char* ipworkssnmp_snmptcpmgr_getsslservercerteffectivedate(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertexpirationdate(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertextendedkeyusage(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertfingerprint(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertfingerprintsha1(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertfingerprintsha256(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertissuer(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertprivatekey(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertpublickey(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslservercertpublickeylength(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertserialnumber(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertsignaturealgorithm(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworkssnmp_snmptcpmgr_getsslservercertstorepassword(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslservercertstoretype(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertsubjectaltnames(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertthumbprintmd5(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertthumbprintsha1(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertthumbprintsha256(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertusage(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslservercertusageflags(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertversion(void* lpObj);

char* ipworkssnmp_snmptcpmgr_getsslservercertsubject(void* lpObj);

int ipworkssnmp_snmptcpmgr_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksSNMPCertificate

StoreWalkObjects Property (SNMPTCPMgr Class)

Tells the class whether or not to store returned objects.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetStoreWalkObjects();
int SetStoreWalkObjects(int bStoreWalkObjects);

Unicode (Windows)
BOOL GetStoreWalkObjects();
INT SetStoreWalkObjects(BOOL bStoreWalkObjects);

int ipworkssnmp_snmptcpmgr_getstorewalkobjects(void* lpObj);
int ipworkssnmp_snmptcpmgr_setstorewalkobjects(void* lpObj, int bStoreWalkObjects);

bool GetStoreWalkObjects();
int SetStoreWalkObjects(bool bStoreWalkObjects);

Default Value

TRUE

Remarks

When a Walk is performed, this property tells the class whether or not to store the objects that are returned by the server in the Objects collection. If the data is accumulated through the events, and not desired to be saved by the class, set this property to false.

Data Type

Boolean

Timeout Property (SNMPTCPMgr Class)

This property includes the timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworkssnmp_snmptcpmgr_gettimeout(void* lpObj);
int ipworkssnmp_snmptcpmgr_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

User Property (SNMPTCPMgr Class)

The user name used for SNMPv3 authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworkssnmp_snmptcpmgr_getuser(void* lpObj);
int ipworkssnmp_snmptcpmgr_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

Default Value

""

Remarks

If authentication is desired, this property must be set before the class attempts to connect to an SNMPv3 Agent.

Data Type

String

WalkLimit Property (SNMPTCPMgr Class)

The limit of oid's returned in a walk.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWalkLimit();
int SetWalkLimit(int iWalkLimit);

Unicode (Windows)
INT GetWalkLimit();
INT SetWalkLimit(INT iWalkLimit);

int ipworkssnmp_snmptcpmgr_getwalklimit(void* lpObj);
int ipworkssnmp_snmptcpmgr_setwalklimit(void* lpObj, int iWalkLimit);

int GetWalkLimit();
int SetWalkLimit(int iWalkLimit);

Default Value

0

Remarks

This property specifies the limit of how many oid's are to be traversed during an SNMP Walk. If set to 0, the class will traverse all oid's in the specified table that are lexographically greater than the value of the specified table oid.

Data Type

Integer

Activate Method (SNMPTCPMgr Class)

Activates the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Activate();

Unicode (Windows)
INT Activate();

int ipworkssnmp_snmptcpmgr_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.)

Config Method (SNMPTCPMgr 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_snmptcpmgr_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 (SNMPTCPMgr Class)

Deactivates the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Deactivate();

Unicode (Windows)
INT Deactivate();

int ipworkssnmp_snmptcpmgr_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.)

Discover Method (SNMPTCPMgr Class)

Performs SNMPv3 discovery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Discover();

Unicode (Windows)
INT Discover();

int ipworkssnmp_snmptcpmgr_discover(void* lpObj);

int Discover();

Remarks

When the method is called an SNMPv3 engine discovery request is sent to RemoteHost.

If an AuthenticationPassword is provided, the engine id discovery request is followed by an engine time discovery request, as required by the SNMPv3 User Security Model (USM). In this case Timeout must be set to a non-zero value before calling Discover and the class will wait until a response is received from RemoteHost.

The DiscoveryResponse event is fired upon receipt of a valid discovery response and the values of RemoteEngineId, RemoteEngineBoots, and RemoteEngineTime will then be updated with the received Engine Id, Time, and Boots.

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 (SNMPTCPMgr Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworkssnmp_snmptcpmgr_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 (SNMPTCPMgr Class)

Hashes all passwords in the cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int HashPasswords();

Unicode (Windows)
INT HashPasswords();

int ipworkssnmp_snmptcpmgr_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.)

Interrupt Method (SNMPTCPMgr Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworkssnmp_snmptcpmgr_interrupt(void* lpObj);

int Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

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 (SNMPTCPMgr Class)

Clears the object arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworkssnmp_snmptcpmgr_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.)

SendGetBulkRequest Method (SNMPTCPMgr Class)

Send a GetBulkRequest packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendGetBulkRequest(int iNonRepeaters, int iMaxRepetitions);

Unicode (Windows)
INT SendGetBulkRequest(INT iNonRepeaters, INT iMaxRepetitions);

int ipworkssnmp_snmptcpmgr_sendgetbulkrequest(void* lpObj, int iNonRepeaters, int iMaxRepetitions);

int SendGetBulkRequest(int iNonRepeaters, int iMaxRepetitions);

Remarks

Sends a GetBulkRequest packet. This is only available for SNMP versions 2 and 3.

NonRepeaters specifies the number of variables for which a single lexicographic successor is to be returned.

MaxRepetitions specifies the number of lexicographic successors to be returned for variables other than those in the NonRepeaters list.

The object identifiers, types, and values for the request are taken from the Objects collection.

A GetBulkRequest is very similar to a GetNextRequest, the difference is that Getbulk performs a continuous GetNext operation based on the MaxRepitions value. The NonRepeaters value will determine the number of Objects for which a simple GetNext operation should be performed. For the remaining variables, a continuous GetNext operation is performed based on the MaxRepitions value.

So if you send a request containing X objects, the agent will perform N simple GetNext operations and M continuous GetNext operations X - N times. With X being the number of objects received, N being the number of NonRepeaters, and M being the number of MaxRepitions. Thus the SNMPMgr is expecting to receive N + M x (X - N) objects, assuming that each object has M successors.

Example (Sending a GetBulk Request)

SNMPControl.RemoteHost = "MyAgent" SNMPControl.ObjCount = 2 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.objId(1) = "1.3.6.1.2.1.1.3.0" SNMPControl.SendGetBulkRequest(1,4)

The code sample above will send a GetBulkRequest with 1 non repeater, and a maxrepetitions of 4. Since there is only 1 non repeater, only one ObjID will "not repeat" and will only return one successor. The rest of the ObjID's (in this case, only 1) will return 4 successors. This particular example will return the following ObjID's:

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

SendGetNextRequest Method (SNMPTCPMgr Class)

Send GetNextRequest packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendGetNextRequest();

Unicode (Windows)
INT SendGetNextRequest();

int ipworkssnmp_snmptcpmgr_sendgetnextrequest(void* lpObj);

int SendGetNextRequest();

Remarks

Sends a GetNextRequest packet. The object identifiers, types, and values for the request are taken from the Objects collection.

Example (Sending a GetNext Request)

SNMPControl.ObjCount = 2 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.SendGetNextRequest() The agent will respond with the "next" (relative to the ObjID(s) you specify) OID in the table.

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

SendGetRequest Method (SNMPTCPMgr Class)

Send GetRequest packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendGetRequest();

Unicode (Windows)
INT SendGetRequest();

int ipworkssnmp_snmptcpmgr_sendgetrequest(void* lpObj);

int SendGetRequest();

Remarks

Sends a GetRequest packet. The object identifiers, types, and values for the request are taken from the Objects collection.

Example (Sending a GetRequest)

SNMPControl.RemoteHost = "MyAgent" SNMPControl.ObjCount = 2 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjId(1) = "1.3.6.1.2.1.1.2.0" SNMPControl.SendGetRequest()

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

SendInformRequest Method (SNMPTCPMgr Class)

Send an InformRequest packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendInformRequest();

Unicode (Windows)
INT SendInformRequest();

int ipworkssnmp_snmptcpmgr_sendinformrequest(void* lpObj);

int SendInformRequest();

Remarks

Sends an InformRequest packet. The object identifiers, types, and values for the request are taken from the Objects collection.

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

SendSetRequest Method (SNMPTCPMgr Class)

Send Set Request packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendSetRequest();

Unicode (Windows)
INT SendSetRequest();

int ipworkssnmp_snmptcpmgr_sendsetrequest(void* lpObj);

int SendSetRequest();

Remarks

Sends a SetRequest packet. The object identifiers, types, and values for the request are taken from the Objects collection.

Example (Sending a SetRequest)

SNMPControl.RemoteHost = "MyAgent" SNMPControl.ObjCount = 1 SNMPControl.ObjId(0) = "1.3.6.1.2.1.1.1.0" SNMPControl.ObjValue(0) = "New Value" SNMPControl.ObjType(0) = otOctetString SNMPControl.SendSetRequest()

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 (SNMPTCPMgr 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_snmptcpmgr_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.

Walk Method (SNMPTCPMgr Class)

Does an SNMP walk starting with the specified oid.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Walk(const char* lpszTableOid);

Unicode (Windows)
INT Walk(LPCWSTR lpszTableOid);

int ipworkssnmp_snmptcpmgr_walk(void* lpObj, const char* lpszTableOid);

int Walk(const QString& qsTableOid);

Remarks

A walk will traverse all OIDs in the TableOid that are lexographically greater than the value of the TableOid.

The results of the walk may be obtained through the Response events. During the event, the current returned object will exist inside of the Objects collection. If StoreWalkObjects is set to true, the Objects collection will contain all returned objects when the Walk completes.

Use the WalkLimit property to regulate how many objects the walk will traverse in the table.

NOTE: The collection of objects is cleared before the walk begins.

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

BadPacket Event (SNMPTCPMgr Class)

Fired for erroneous and/or malformed messages.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPMGR_BADPACKET 1

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

class SNMPTCPMgrBadPacketEventParams {
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(SNMPTCPMgrBadPacketEventParams *e);

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireBadPacket(SNMPTCPMgrBadPacketEventParams *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.

Connected Event (SNMPTCPMgr Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(SNMPTCPMgrConnectedEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  int StatusCode;
  const char *Description;
  int reserved;
} SNMPTCPMgrConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(SNMPTCPMgrConnectedEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SNMPTCPMgrConnectedEventParams;

#define EID_SNMPTCPMGR_CONNECTED 2

virtual INT IPWORKSSNMP_CALL FireConnected(LPSTR &lpszRemoteAddress, INT &iRemotePort, INT &iStatusCode, LPSTR &lpszDescription);

class SNMPTCPMgrConnectedEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  int StatusCode();

  const QString &Description();

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

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

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireConnected(SNMPTCPMgrConnectedEventParams *e) {...}

Remarks

This event fires after a connection completes or fails.

StatusCode is the value returned by the system TCP/IP stack. This will be 0 if the connection was successful.

Description contains a human readable description of the status. This will be "OK" if the connection was successful.

RemoteAddress is the IP address of the remote host.

RemotePort is the port on the remote host.

ConnectionStatus Event (SNMPTCPMgr Class)

This event is fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(SNMPTCPMgrConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} SNMPTCPMgrConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(SNMPTCPMgrConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SNMPTCPMgrConnectionStatusEventParams;

#define EID_SNMPTCPMGR_CONNECTIONSTATUS 3

virtual INT IPWORKSSNMP_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class SNMPTCPMgrConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

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

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

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireConnectionStatus(SNMPTCPMgrConnectionStatusEventParams *e) {...}

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Disconnected Event (SNMPTCPMgr Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(SNMPTCPMgrDisconnectedEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  int StatusCode;
  const char *Description;
  int reserved;
} SNMPTCPMgrDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(SNMPTCPMgrDisconnectedEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SNMPTCPMgrDisconnectedEventParams;

#define EID_SNMPTCPMGR_DISCONNECTED 4

virtual INT IPWORKSSNMP_CALL FireDisconnected(LPSTR &lpszRemoteAddress, INT &iRemotePort, INT &iStatusCode, LPSTR &lpszDescription);

class SNMPTCPMgrDisconnectedEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  int StatusCode();

  const QString &Description();

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

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

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireDisconnected(SNMPTCPMgrDisconnectedEventParams *e) {...}

Remarks

This event fires after a connection is broken.

StatusCode is the value returned by the system TCP/IP stack. This will be 0 if the connection was broken normally.

Description contains a human readable description of the status. This will be "OK" if the connection was broken normally.

RemoteAddress is the IP address of the remote host.

RemotePort is the port on the remote host.

DiscoveryRequest Event (SNMPTCPMgr Class)

Fired when an SNMPv3 discovery packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDiscoveryRequest(SNMPTCPMgrDiscoveryRequestEventParams *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;
} SNMPTCPMgrDiscoveryRequestEventParams;


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

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

#define EID_SNMPTCPMGR_DISCOVERYREQUEST 5

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

class SNMPTCPMgrDiscoveryRequestEventParams {
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(SNMPTCPMgrDiscoveryRequestEventParams *e);

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireDiscoveryRequest(SNMPTCPMgrDiscoveryRequestEventParams *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).

DiscoveryResponse Event (SNMPTCPMgr Class)

Fired when an SNMPv3 discovery response is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDiscoveryResponse(SNMPTCPMgrDiscoveryResponseEventParams *e);

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


Unicode (Windows)
virtual INT FireDiscoveryResponse(SNMPTCPMgrDiscoveryResponseEventParams *e);

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

#define EID_SNMPTCPMGR_DISCOVERYRESPONSE 6

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

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

  int EngineBoots();

  int EngineTime();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

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

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

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireDiscoveryResponse(SNMPTCPMgrDiscoveryResponseEventParams *e) {...}

Remarks

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

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 request, SecurityLevel is at least 1.

Error Event (SNMPTCPMgr Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPMGR_ERROR 7

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

class SNMPTCPMgrErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireError(SNMPTCPMgrErrorEventParams *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.

HashPassword Event (SNMPTCPMgr Class)

Fired before and after a password is hashed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPMGR_HASHPASSWORD 8

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

class SNMPTCPMgrHashPasswordEventParams {
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(SNMPTCPMgrHashPasswordEventParams *e);

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireHashPassword(SNMPTCPMgrHashPasswordEventParams *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 (SNMPTCPMgr Class)

Fired when an InformRequest packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireInformRequest(SNMPTCPMgrInformRequestEventParams *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;
} SNMPTCPMgrInformRequestEventParams;


Unicode (Windows)
virtual INT FireInformRequest(SNMPTCPMgrInformRequestEventParams *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;
} SNMPTCPMgrInformRequestEventParams;

#define EID_SNMPTCPMGR_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 SNMPTCPMgrInformRequestEventParams {
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(SNMPTCPMgrInformRequestEventParams *e);

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

Remarks

The user in an InformRequest packet (SNMPv3) must match the user in the User property. 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 Oid, ObjectType, and Value 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 (SNMPTCPMgr Class)

Fired for every packet sent or received.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPMGR_PACKETTRACE 10

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

class SNMPTCPMgrPacketTraceEventParams {
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(SNMPTCPMgrPacketTraceEventParams *e);

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FirePacketTrace(SNMPTCPMgrPacketTraceEventParams *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.

ReadyToSend Event (SNMPTCPMgr Class)

Fired when the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReadyToSend(SNMPTCPMgrReadyToSendEventParams *e);

typedef struct {
  int reserved;
} SNMPTCPMgrReadyToSendEventParams;


Unicode (Windows)
virtual INT FireReadyToSend(SNMPTCPMgrReadyToSendEventParams *e);

typedef struct {
  INT reserved;
} SNMPTCPMgrReadyToSendEventParams;

#define EID_SNMPTCPMGR_READYTOSEND 11

virtual INT IPWORKSSNMP_CALL FireReadyToSend();

class SNMPTCPMgrReadyToSendEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

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

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireReadyToSend(SNMPTCPMgrReadyToSendEventParams *e) {...}

Remarks

The ReadyToSend event indicates that the underlying TCP/IP subsystem is ready to accept data after a failed DataToSend(TBD. DataToSend is removed).

Report Event (SNMPTCPMgr Class)

Fired when a Report packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReport(SNMPTCPMgrReportEventParams *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 reserved;
} SNMPTCPMgrReportEventParams;


Unicode (Windows)
virtual INT FireReport(SNMPTCPMgrReportEventParams *e);

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

#define EID_SNMPTCPMGR_REPORT 12

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

class SNMPTCPMgrReportEventParams {
public:
  int RequestId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

  int ErrorIndex();

  int ErrorStatus();

  const QString &ErrorDescription();

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

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

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireReport(SNMPTCPMgrReportEventParams *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 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 Oid, ObjectType, and Value 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.

Response Event (SNMPTCPMgr Class)

Fired when a GetResponse packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireResponse(SNMPTCPMgrResponseEventParams *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 reserved;
} SNMPTCPMgrResponseEventParams;


Unicode (Windows)
virtual INT FireResponse(SNMPTCPMgrResponseEventParams *e);

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

#define EID_SNMPTCPMGR_RESPONSE 13

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

class SNMPTCPMgrResponseEventParams {
public:
  int RequestId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

  int ErrorIndex();

  int ErrorStatus();

  const QString &ErrorDescription();

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

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

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireResponse(SNMPTCPMgrResponseEventParams *e) {...}

Remarks

The ErrorStatus and ErrorIndex parameters contain information about possible errors. ErrorDescription is a textual description of ErrorStatus. This value is parsed directly from the SNMP response, which will be a one-based value, so a value of i here maps to index i-1 in the Objects collection.

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

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 Oid, ObjectType, and Value 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.

SSLClientAuthentication Event (SNMPTCPMgr Class)

Fired when the client presents its credentials to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLClientAuthentication(SNMPTCPMgrSSLClientAuthenticationEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} SNMPTCPMgrSSLClientAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLClientAuthentication(SNMPTCPMgrSSLClientAuthenticationEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} SNMPTCPMgrSSLClientAuthenticationEventParams;

#define EID_SNMPTCPMGR_SSLCLIENTAUTHENTICATION 14

virtual INT IPWORKSSNMP_CALL FireSSLClientAuthentication(LPSTR &lpszRemoteAddress, INT &iRemotePort, LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class SNMPTCPMgrSSLClientAuthenticationEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

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

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

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

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireSSLClientAuthentication(SNMPTCPMgrSSLClientAuthenticationEventParams *e) {...}

Remarks

This event fires when a client connects to the class and presents a certificate for authentication. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

RemoteAddress is the IP address of the connecting client.

RemotePort is the source port of the connecting client.

CertEncoded is the base64 encoded certificate presented by the client.

CertSubject is the subject of the certificate presented by the client.

CertIssuer is the subject of the issuer of the certificate presented by the client.

Status is the stauts of the certificate.

Accept defines whether the certificate is accepted.

SSLServerAuthentication Event (SNMPTCPMgr Class)

Fires when connecting to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(SNMPTCPMgrSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} SNMPTCPMgrSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(SNMPTCPMgrSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} SNMPTCPMgrSSLServerAuthenticationEventParams;

#define EID_SNMPTCPMGR_SSLSERVERAUTHENTICATION 15

virtual INT IPWORKSSNMP_CALL FireSSLServerAuthentication(LPSTR &lpszRemoteAddress, INT &iRemotePort, LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class SNMPTCPMgrSSLServerAuthenticationEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

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

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

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

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireSSLServerAuthentication(SNMPTCPMgrSSLServerAuthenticationEventParams *e) {...}

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

RemoteAddress is the IP address of the server.

RemotePort is the source port of the server.

CertEncoded is the base64 encoded certificate presented by the server.

CertSubject is the subject of the certificate presented by the server.

CertIssuer is the subject of the issuer of the certificate presented by the server.

Status is the stauts of the certificate.

Accept defines whether the certificate is accepted.

SSLStatus Event (SNMPTCPMgr Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(SNMPTCPMgrSSLStatusEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  const char *Message;
  int reserved;
} SNMPTCPMgrSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(SNMPTCPMgrSSLStatusEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  LPCWSTR Message;
  INT reserved;
} SNMPTCPMgrSSLStatusEventParams;

#define EID_SNMPTCPMGR_SSLSTATUS 16

virtual INT IPWORKSSNMP_CALL FireSSLStatus(LPSTR &lpszRemoteAddress, INT &iRemotePort, LPSTR &lpszMessage);

class SNMPTCPMgrSSLStatusEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  const QString &Message();

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

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

// Or, subclass SNMPTCPMgr and override this emitter function.
virtual int FireSSLStatus(SNMPTCPMgrSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

RemoteAddress is the IP address of the remote machine.

RemotePort is the port of the remote machine.

Message is the log message.

Trap Event (SNMPTCPMgr Class)

Fired when a SNMP trap packet is received.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPMGR_TRAP 17

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

class SNMPTCPMgrTrapEventParams {
public:
  int RequestId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &TrapOID();

  qint64 TimeStamp();

  const QString &SourceAddress();

  int SourcePort();

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

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

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

Remarks

The SNMPTrapMgr class should normally be used to receive traps, since it was designed and contains functionality specifically for that purpose. The SNMPMgr component can only receive traps from the agent that it is has most recently discovered with the Discover method.

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 SNMPMgr class is limited to accepting authenticated traps only for the user specified in User and Password and from the engine specified in RemoteEngineId with time parameters in RemoteEngineBoots and RemoteEngineTime (usually this is the SNMP engine discovered through the last call to Discover). If authenticated traps come from a different engine, or for a different user, they are ignored, and a BadPacket event is fired instead.

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 Oid, ObjectType, and Value 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.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksSNMPCertificate (declared in ipworkssnmp.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

SNMPObject Type

The current SNMP object.

Syntax

IPWorksSNMPSNMPObject (declared in ipworkssnmp.h)

Remarks

This type defines an SNMP object. Each object has an Oid, ObjectType, and Value. These values are populated by the class when incoming packets are received. You may use these fields to define objects to be used in outgoing packets.

Fields

Constructors

SNMPObject()

SNMPObject(const char* lpszOid)

SNMPObject(const char* lpszOid, const char* lpValue, int lenValue)

SNMPObject(const char* lpszOid, const char* lpValue, int lenValue, int iObjectType)

IPWorksSNMPList Type

Syntax

IPWorksSNMPList<T> (declared in ipworkssnmp.h)

Remarks

IPWorksSNMPList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SNMPTCPMgr class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (SNMPTCPMgr Class)

SNMPTCPManager Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (SNMPTCPMgr 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.

SNMPTCPMgr Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors