SNMPTCPAgent Class

Properties   Methods   Events   Config Settings   Errors  

The SNMPTCPAgent class is used to implement TCP-based SNMP Agent Applications.

Syntax

SNMPTCPAgent

Remarks

The SNMPTCPAgent class implements a TCP-based standard SNMP Agent 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 agent as simple as setting a few key properties and handling a few events. SNMP data such as 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.

The class operates asynchronously. Requests are received through events such as GetRequest, GetBulkRequest, GetNextRequest, etc. and the corresponding responses are automatically sent when the events return. Traps are sent through the SendTrap method.

SNMPv3 USM security passwords are requested through the GetUserPassword event, and event parameters such as User and SecurityLevel provide information about the security attributes of received requests, and enable granular decision capability about what to provide and what not to provide. The SendSecureTrap method is used to send authenticated (secure) SNMPv3 traps.

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

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

Other packet information is provided through corresponding event parameters, such as Community, or RequestId.

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 (SNMPTCPAgent 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_snmptcpagent_getacceptdata(void* lpObj);
int ipworkssnmp_snmptcpagent_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 (SNMPTCPAgent 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_snmptcpagent_getactive(void* lpObj);
int ipworkssnmp_snmptcpagent_setactive(void* lpObj, int bActive);

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

Default Value

FALSE

Remarks

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

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

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

This property is not available at design time.

Data Type

Boolean

LocalEngineId Property (SNMPTCPAgent Class)

The Engine Id of the SNMP Agent.

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_snmptcpagent_getlocalengineid(void* lpObj, char** lpLocalEngineId, int* lenLocalEngineId);
int ipworkssnmp_snmptcpagent_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 (SNMPTCPAgent 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_snmptcpagent_getlocalhost(void* lpObj);
int ipworkssnmp_snmptcpagent_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

LocalPort Property (SNMPTCPAgent Class)

The port in the local host where the class listens.

Syntax

• C++
• C
• Qt

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

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

int ipworkssnmp_snmptcpagent_getlocalport(void* lpObj);
int ipworkssnmp_snmptcpagent_setlocalport(void* lpObj, int iLocalPort);

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

Default Value

161

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 (default 161).

You may also set LocalPort to 0. This allows the TCP/IP stack to choose a port at random. The value chosen is provided via the LocalPort property after the class is activated through the Active property.

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

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

Data Type

Integer

ObjCount Property (SNMPTCPAgent Class)

The number of records in the Obj arrays.

Syntax

• C++
• C
• Qt

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

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

int ipworkssnmp_snmptcpagent_getobjcount(void* lpObj);
int ipworkssnmp_snmptcpagent_setobjcount(void* lpObj, int iObjCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• ObjId
• ObjType
• ObjTypeString
• ObjValue

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

This property is not available at design time.

Data Type

Integer

ObjType Property (SNMPTCPAgent Class)

The current object's type.

Syntax

• C++
• C
• Qt

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

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

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

int ipworkssnmp_snmptcpagent_getobjtype(void* lpObj, int objindex);
int ipworkssnmp_snmptcpagent_setobjtype(void* lpObj, int objindex, int iObjType);

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

Default Value

5

Remarks

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

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

Possible object type values include:

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

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

This property is not available at design time.

Data Type

Integer

ObjId Property (SNMPTCPAgent Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworkssnmp_snmptcpagent_getobjid(void* lpObj, int objindex);
int ipworkssnmp_snmptcpagent_setobjid(void* lpObj, int objindex, const char* lpszObjId);

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

Default Value

""

Remarks

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

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

Example

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

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

This property is not available at design time.

Data Type

String

ObjTypeString Property (SNMPTCPAgent Class)

A string representation of the current object's ObjectType .

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetObjTypeString(INT iObjIndex);

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

QString GetObjTypeString(int iObjIndex);

Default Value

""

Remarks

A string representation of the current object's ObjectType.

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

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

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

Data Type

String

ObjValue Property (SNMPTCPAgent Class)

The current object's value.

Syntax

• C++
• C
• Qt

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

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

int ipworkssnmp_snmptcpagent_getobjvalue(void* lpObj, int objindex, char** lpObjValue, int* lenObjValue);
int ipworkssnmp_snmptcpagent_setobjvalue(void* lpObj, int objindex, const char* lpObjValue, int lenObjValue);

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

Default Value

""

Remarks

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

Example

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

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

This property is not available at design time.

Data Type

Binary String

RequestId Property (SNMPTCPAgent 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_snmptcpagent_getrequestid(void* lpObj);
int ipworkssnmp_snmptcpagent_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 (SNMPTCPAgent Class)

Version of SNMP used for outgoing requests (traps).

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_snmptcpagent_getsnmpversion(void* lpObj);
int ipworkssnmp_snmptcpagent_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

SSLAcceptServerCertEncoded Property (SNMPTCPAgent Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworkssnmp_snmptcpagent_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworkssnmp_snmptcpagent_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

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

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLAuthenticateClients Property (SNMPTCPAgent 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_snmptcpagent_getsslauthenticateclients(void* lpObj);
int ipworkssnmp_snmptcpagent_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

SSLCertEncoded Property (SNMPTCPAgent Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworkssnmp_snmptcpagent_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworkssnmp_snmptcpagent_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

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

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (SNMPTCPAgent Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworkssnmp_snmptcpagent_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworkssnmp_snmptcpagent_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

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

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (SNMPTCPAgent Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworkssnmp_snmptcpagent_getsslcertstorepassword(void* lpObj);
int ipworkssnmp_snmptcpagent_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

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

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (SNMPTCPAgent Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworkssnmp_snmptcpagent_getsslcertstoretype(void* lpObj);
int ipworkssnmp_snmptcpagent_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (SNMPTCPAgent Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworkssnmp_snmptcpagent_getsslcertsubject(void* lpObj);
int ipworkssnmp_snmptcpagent_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

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

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLEnabled Property (SNMPTCPAgent 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_snmptcpagent_getsslenabled(void* lpObj);
int ipworkssnmp_snmptcpagent_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.

Note: SSL is not currently supported in this product. This setting is reserved for future user.

This property is not available at design time.

Data Type

Boolean

SSLServerCertEncoded Property (SNMPTCPAgent Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

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

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

SysUpTime Property (SNMPTCPAgent Class)

Time passed since the agent was initialized (in hundredths of a second).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetSysUpTime();
int SetSysUpTime(int64 lSysUpTime);

Unicode (Windows)
LONG64 GetSysUpTime();
INT SetSysUpTime(LONG64 lSysUpTime);

int64 ipworkssnmp_snmptcpagent_getsysuptime(void* lpObj);
int ipworkssnmp_snmptcpagent_setsysuptime(void* lpObj, int64 lSysUpTime);

qint64 GetSysUpTime();
int SetSysUpTime(qint64 lSysUpTime);

Default Value

0

Remarks

This property is used when sending SNMP traps, and it normally provides the time since the system was restarted in 1/100s of a second.

If another value is desired, you may set this property to a custom value. From that point on, SysUpTime will return the value set plus time elapsed.

This property is not available at design time.

Data Type

Long64

Activate Method (SNMPTCPAgent Class)

Activates the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Activate();

Unicode (Windows)
INT Activate();

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

AddUser Method (SNMPTCPAgent Class)

Adds a user to the internal authentication cache.

Syntax

• C++
• C
• Qt

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

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

int ipworkssnmp_snmptcpagent_adduser(void* lpObj, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);

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

Remarks

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

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

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

Valid Authentication Protocols are:

Valid Encryption Algorithms are:

NOTE: Specifying an authentication protocol of 0 is a special case where the class will attempt to verify users with all valid authentication protocols.

Error Handling (C++)

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

ClearCache Method (SNMPTCPAgent Class)

Clears the internal authentication database.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ClearCache();

Unicode (Windows)
INT ClearCache();

int ipworkssnmp_snmptcpagent_clearcache(void* lpObj);

int ClearCache();

Remarks

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

Error Handling (C++)

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

Config Method (SNMPTCPAgent 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_snmptcpagent_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 (SNMPTCPAgent Class)

Deactivates the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Deactivate();

Unicode (Windows)
INT Deactivate();

int ipworkssnmp_snmptcpagent_deactivate(void* lpObj);

int Deactivate();

Remarks

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

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

Error Handling (C++)

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

DoEvents Method (SNMPTCPAgent Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworkssnmp_snmptcpagent_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 (SNMPTCPAgent Class)

Hashes all passwords in the cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int HashPasswords();

Unicode (Windows)
INT HashPasswords();

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

RemoveUser Method (SNMPTCPAgent Class)

Removes the user specified by User from the internal authentication cache.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT RemoveUser(LPCWSTR lpszUser);

int ipworkssnmp_snmptcpagent_removeuser(void* lpObj, const char* lpszUser);

int RemoveUser(const QString& qsUser);

Remarks

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

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

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

Error Handling (C++)

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

Reset Method (SNMPTCPAgent Class)

Clears the object arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

SendResponse Method (SNMPTCPAgent Class)

Sends a response packet to a Get, Get-Next, Get-Bulk, or Set request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendResponse(const char* lpszRemoteHost, int iRemotePort, int iRequestId, const char* lpszCommunity, int iErrorStatus, int iErrorIndex);

Unicode (Windows)
INT SendResponse(LPCWSTR lpszRemoteHost, INT iRemotePort, INT iRequestId, LPCWSTR lpszCommunity, INT iErrorStatus, INT iErrorIndex);

int ipworkssnmp_snmptcpagent_sendresponse(void* lpObj, const char* lpszRemoteHost, int iRemotePort, int iRequestId, const char* lpszCommunity, int iErrorStatus, int iErrorIndex);

int SendResponse(const QString& qsRemoteHost, int iRemotePort, int iRequestId, const QString& qsCommunity, int iErrorStatus, int iErrorIndex);

Remarks

Use this method to send asynchronous response packets. A valid RequestId must be specified. SendResponse sends an unauthenticated response packet. Depending upon the value of the SNMPVersion property, the packet is constructed as an SNMPv1, SNMPv2c, or SNMPv3 (unauthenticated) response PDU. To send authenticated or encrypted SNMPv3 responses, use SendSecureResponse

The RemoteHost and RemotePort parameters are used to determine where the response is to be sent. The object identifiers, types, and values for the request are taken from the Objects collection. The RequestId, Community, ErrorStatus, and ErrorIndex parameters are used to specify other properties of the response.

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

SendSecureResponse Method (SNMPTCPAgent Class)

Sends an authenticated and/or encrypted SNMPv3 response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendSecureResponse(const char* lpszRemoteHost, int iRemotePort, int iRequestId, int iMessageId, int iErrorStatus, int iErrorIndex, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);

Unicode (Windows)
INT SendSecureResponse(LPCWSTR lpszRemoteHost, INT iRemotePort, INT iRequestId, INT iMessageId, INT iErrorStatus, INT iErrorIndex, LPCWSTR lpszUser, INT iAuthenticationProtocol, LPCWSTR lpszAuthenticationPassword, INT iEncryptionAlgorithm, LPCWSTR lpszEncryptionPassword);

int ipworkssnmp_snmptcpagent_sendsecureresponse(void* lpObj, const char* lpszRemoteHost, int iRemotePort, int iRequestId, int iMessageId, int iErrorStatus, int iErrorIndex, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);

int SendSecureResponse(const QString& qsRemoteHost, int iRemotePort, int iRequestId, int iMessageId, int iErrorStatus, int iErrorIndex, const QString& qsUser, int iAuthenticationProtocol, const QString& qsAuthenticationPassword, int iEncryptionAlgorithm, const QString& qsEncryptionPassword);

Remarks

Similar to the SendResponse method except that User, Authentication Protocol, and AuthenticationPassword are used to authenticate the response. EncryptionAlgorithm and EncryptionPassword (if not empty) are used to encrypt the response.

The MessageId argument must match the MessageId parameter obtained from the GetRequest, GetNextRequest, SetRequest, or GetBulkRequest event.

The user and password arguments used to send the response will be added to the internal user cache. If the user is already in the cache, its passwords will be updated with those supplied.

Valid Authentication Protocols are:

Valid Encryption Algorithms are:

Error Handling (C++)

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

SendSecureTrap Method (SNMPTCPAgent Class)

Sends an authenticated and/or encrypted SNMPv3 trap.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendSecureTrap(const char* lpszRemoteHost, const char* lpszTrapOID, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);

Unicode (Windows)
INT SendSecureTrap(LPCWSTR lpszRemoteHost, LPCWSTR lpszTrapOID, LPCWSTR lpszUser, INT iAuthenticationProtocol, LPCWSTR lpszAuthenticationPassword, INT iEncryptionAlgorithm, LPCWSTR lpszEncryptionPassword);

int ipworkssnmp_snmptcpagent_sendsecuretrap(void* lpObj, const char* lpszRemoteHost, const char* lpszTrapOID, const char* lpszUser, int iAuthenticationProtocol, const char* lpszAuthenticationPassword, int iEncryptionAlgorithm, const char* lpszEncryptionPassword);

int SendSecureTrap(const QString& qsRemoteHost, const QString& qsTrapOID, const QString& qsUser, int iAuthenticationProtocol, const QString& qsAuthenticationPassword, int iEncryptionAlgorithm, const QString& qsEncryptionPassword);

Remarks

Similar to the SendTrap method except that User, AuthenticationPassword, and Authentication Protocol are used to authenticate the trap. EncryptionPassword (if not empty) and EncryptionAlgorithm are used to encrypt the message.

The user and password arguments used to send the trap will be added to the internal user cache. If the user is already in the cache, its passwords will be updated with those supplied.

Valid Authentication Protocols are:

Valid Encryption Algorithms are:

Error Handling (C++)

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

SendTrap Method (SNMPTCPAgent Class)

Sends an SNMP Trap.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendTrap(const char* lpszRemoteHost, const char* lpszTrapOID);

Unicode (Windows)
INT SendTrap(LPCWSTR lpszRemoteHost, LPCWSTR lpszTrapOID);

int ipworkssnmp_snmptcpagent_sendtrap(void* lpObj, const char* lpszRemoteHost, const char* lpszTrapOID);

int SendTrap(const QString& qsRemoteHost, const QString& qsTrapOID);

Remarks

Depending upon the value of the SNMPVersion property, the packet is constructed as an SNMPv1 or SNMPv2 Trap PDU. The following configuration settings provide more control about how traps are generated: TrapPort, TrapAgentAddress, TrapCommunity, TrapEnterprise. The SysUpTime property provides the trap timestamp.

SendTrap sends an unauthenticated trap. The SendSecureTrap method is used to send authenticated SNMPv3 traps.

If any values are provided in the Objects collection, they are sent unchanged. In the case of an SNMPv2 or SNMPv3 Trap, if Objects has a count that is equal to 0, the following values are set: sysUpTime.0 equal to SysUpTime and snmpTrapOID.0 equal to TrapOID.

For SNMPv2 and SNMPv3 Traps, TrapOID must contain the full OID of the Trap. For SNMPv1, TrapOID must be a string of the form "generic.specific" where generic and specific are numeric values providing the Trap Generic Type and Specific Type.

For SNMPv1, TrapOID must be of the form "GenericTrap.SpecificTrap". These values are sent in the PDU header. TrapAgentAddress and TrapEnterprise are taken from the corresponding configuration settings.

Additionally, the following symbolic values are recognized and translated as follows:

Error Handling (C++)

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

ShowCache Method (SNMPTCPAgent Class)

Lists all entries in the internal user authentication cache.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ShowCache();

Unicode (Windows)
INT ShowCache();

int ipworkssnmp_snmptcpagent_showcache(void* lpObj);

int ShowCache();

Remarks

A CacheEntry event is fired for every record in the internal user authentication cache.

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

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

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

Error Handling (C++)

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

Value Method (SNMPTCPAgent 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_snmptcpagent_value(void* lpObj, const char* lpszOID);

QString Value(const QString& qsOID);

Remarks

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

Please refer to the SNMPObject type for more information.

Error Handling (C++)

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

BadPacket Event (SNMPTCPAgent Class)

Fired for erroneous and/or malformed messages.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPAGENT_BADPACKET 1

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

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

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

Remarks

The full message is provided in the Packet parameter.

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

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

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

CacheEntry Event (SNMPTCPAgent Class)

Shows in the internal cache.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *User;
  const char *AuthenticationProtocol;
  const char *AuthenticationPassword;
  const char *EncryptionAlgorithm;
  const char *EncryptionPassword;
  int reserved;
} SNMPTCPAgentCacheEntryEventParams;


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

typedef struct {
  LPCWSTR User;
  LPCWSTR AuthenticationProtocol;
  LPCWSTR AuthenticationPassword;
  LPCWSTR EncryptionAlgorithm;
  LPCWSTR EncryptionPassword;
  INT reserved;
} SNMPTCPAgentCacheEntryEventParams;

#define EID_SNMPTCPAGENT_CACHEENTRY 2

virtual INT IPWORKSSNMP_CALL FireCacheEntry(LPSTR &lpszUser, LPSTR &lpszAuthenticationProtocol, LPSTR &lpszAuthenticationPassword, LPSTR &lpszEncryptionAlgorithm, LPSTR &lpszEncryptionPassword);

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

  const QString &AuthenticationProtocol();

  const QString &AuthenticationPassword();

  const QString &EncryptionAlgorithm();

  const QString &EncryptionPassword();

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

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

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

Remarks

CacheEntry events are triggered by a call to ShowCache. One event is fired for each user.

Connected Event (SNMPTCPAgent Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPAGENT_CONNECTED 3

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

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

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

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPAGENT_CONNECTIONSTATUS 4

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

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

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

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPAGENT_DISCONNECTED 5

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

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

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

Fired when an SNMPv3 discovery packet is received.

Syntax

• C++
• C
• Qt

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


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

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

#define EID_SNMPTCPAGENT_DISCOVERYREQUEST 6

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

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

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

Remarks

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

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

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

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

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

Error Event (SNMPTCPAgent Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPAGENT_ERROR 7

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

class SNMPTCPAgentErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

GetBulkRequest Event (SNMPTCPAgent Class)

Fired when a GetBulkRequest packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGetBulkRequest(SNMPTCPAgentGetBulkRequestEventParams *e);

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


Unicode (Windows)
virtual INT FireGetBulkRequest(SNMPTCPAgentGetBulkRequestEventParams *e);

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

#define EID_SNMPTCPAGENT_GETBULKREQUEST 8

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

class SNMPTCPAgentGetBulkRequestEventParams {
public:
  int RequestId();

  int MessageId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

  int NonRepeaters();

  int MaxRepetitions();

  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 GetBulkRequest(SNMPTCPAgentGetBulkRequestEventParams *e);

// Or, subclass SNMPTCPAgent and override this emitter function.
virtual int FireGetBulkRequest(SNMPTCPAgentGetBulkRequestEventParams *e) {...}

Remarks

This is only available for SNMP versions 2 and 3.

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

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

The MessageId parameter identifies the received request.

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

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

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

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

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

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.

GetNextRequest Event (SNMPTCPAgent Class)

Fired when a GetNextRequest packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGetNextRequest(SNMPTCPAgentGetNextRequestEventParams *e);

typedef struct {
  int RequestId;
  int MessageId;
  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;
} SNMPTCPAgentGetNextRequestEventParams;


Unicode (Windows)
virtual INT FireGetNextRequest(SNMPTCPAgentGetNextRequestEventParams *e);

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

#define EID_SNMPTCPAGENT_GETNEXTREQUEST 9

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

class SNMPTCPAgentGetNextRequestEventParams {
public:
  int RequestId();

  int MessageId();

  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 GetNextRequest(SNMPTCPAgentGetNextRequestEventParams *e);

// Or, subclass SNMPTCPAgent and override this emitter function.
virtual int FireGetNextRequest(SNMPTCPAgentGetNextRequestEventParams *e) {...}

Remarks

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

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

The MessageId parameter identifies the received request.

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

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

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

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

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

GetRequest Event (SNMPTCPAgent Class)

Fired when a GetRequest packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGetRequest(SNMPTCPAgentGetRequestEventParams *e);

typedef struct {
  int RequestId;
  int MessageId;
  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;
} SNMPTCPAgentGetRequestEventParams;


Unicode (Windows)
virtual INT FireGetRequest(SNMPTCPAgentGetRequestEventParams *e);

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

#define EID_SNMPTCPAGENT_GETREQUEST 10

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

class SNMPTCPAgentGetRequestEventParams {
public:
  int RequestId();

  int MessageId();

  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 GetRequest(SNMPTCPAgentGetRequestEventParams *e);

// Or, subclass SNMPTCPAgent and override this emitter function.
virtual int FireGetRequest(SNMPTCPAgentGetRequestEventParams *e) {...}

Remarks

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

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

The MessageId parameter identifies the received request.

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

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

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

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

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

GetUserPassword Event (SNMPTCPAgent Class)

Retrieves a password associated with a user.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int PasswordType;
  const char *User;
  char *Password;
  int Algorithm;
  int reserved;
} SNMPTCPAgentGetUserPasswordEventParams;


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

typedef struct {
  INT PasswordType;
  LPCWSTR User;
  LPWSTR Password;
  INT Algorithm;
  INT reserved;
} SNMPTCPAgentGetUserPasswordEventParams;

#define EID_SNMPTCPAGENT_GETUSERPASSWORD 11

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

class SNMPTCPAgentGetUserPasswordEventParams {
public:
  int PasswordType();

  const QString &User();

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

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

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

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

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

Remarks

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

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

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

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

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

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

GetUserSecurityLevel Event (SNMPTCPAgent Class)

Sets the security level for an incoming packet.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPAGENT_GETUSERSECURITYLEVEL 12

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

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

  const QByteArray &EngineId();

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

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

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

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

Remarks

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

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

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

HashPassword Event (SNMPTCPAgent Class)

Fired before and after a password is hashed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPAGENT_HASHPASSWORD 13

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

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

// Or, subclass SNMPTCPAgent and override this emitter function.
virtual int FireHashPassword(SNMPTCPAgentHashPasswordEventParams *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

PacketTrace Event (SNMPTCPAgent Class)

Fired for every packet sent or received.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPAGENT_PACKETTRACE 14

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

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

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

Fired when the class is ready to send data.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int reserved;
} SNMPTCPAgentReadyToSendEventParams;


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

typedef struct {
  INT reserved;
} SNMPTCPAgentReadyToSendEventParams;

#define EID_SNMPTCPAGENT_READYTOSEND 15

virtual INT IPWORKSSNMP_CALL FireReadyToSend();

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

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

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

Remarks

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

Report Event (SNMPTCPAgent Class)

Fired when a Report packet is received.

Syntax

• C++
• C
• Qt

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


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

#define EID_SNMPTCPAGENT_REPORT 16

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

// Or, subclass SNMPTCPAgent and override this emitter function.
virtual int FireReport(SNMPTCPAgentReportEventParams *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 ObjId, ObjType, and ObjValue of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

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

SetRequest Event (SNMPTCPAgent Class)

Fired when a SetRequest packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSetRequest(SNMPTCPAgentSetRequestEventParams *e);

typedef struct {
  int RequestId;
  int MessageId;
  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;
} SNMPTCPAgentSetRequestEventParams;


Unicode (Windows)
virtual INT FireSetRequest(SNMPTCPAgentSetRequestEventParams *e);

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

#define EID_SNMPTCPAGENT_SETREQUEST 17

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

class SNMPTCPAgentSetRequestEventParams {
public:
  int RequestId();

  int MessageId();

  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 SetRequest(SNMPTCPAgentSetRequestEventParams *e);

// Or, subclass SNMPTCPAgent and override this emitter function.
virtual int FireSetRequest(SNMPTCPAgentSetRequestEventParams *e) {...}

Remarks

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

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

The MessageId parameter identifies the received request.

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

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

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

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

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

SSLClientAuthentication Event (SNMPTCPAgent Class)

Fired when the client presents its credentials to the server.

Syntax

• C++
• C
• Qt

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


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

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

#define EID_SNMPTCPAGENT_SSLCLIENTAUTHENTICATION 18

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

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

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

Fires when connecting to the server.

Syntax

• C++
• C
• Qt

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


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

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

#define EID_SNMPTCPAGENT_SSLSERVERAUTHENTICATION 19

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

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

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

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SNMPTCPAGENT_SSLSTATUS 20

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

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

// Or, subclass SNMPTCPAgent and override this emitter function.
virtual int FireSSLStatus(SNMPTCPAgentSSLStatusEventParams *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.

Config Settings (SNMPTCPAgent Class)

SNMPTCPAgent Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

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

SNMPTCPAgent 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