SNMPMgr Class

Properties Methods Events Config Settings Errors

The SNMPMgr class is used to implement UDP-based SNMP Management Applications.

Syntax

SNMPMgr

Remarks

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

SNMP over DTLS is also supported when SSLEnabled is set to True. When acting as a client, the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the DTLS handshake. Additional SSL-related settings are also supported through the Config method. When acting as a server, the SSLCert properties are used to select a certificate for the server. When client authentication is required, the SSLAuthenticateClients property can be set to True and the SSLClientAuthentication event can be used to examine client credentials.

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

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

Messages are received through events such as Response, Trap, or InformRequest. SNMP Traps are received through the Trap event.

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

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

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

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

Property List

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


AcceptData	Enables or disables data reception.
Active	Indicates whether the class is active.
AuthenticationPassword	The password used for SNMPv3 authentication.
AuthenticationProtocol	The authentication protocol used for SNMPv3 packets.
Community	The community string used to authenticate SNMP packets.
EncryptionAlgorithm	The encryption algorithm used for SNMPv3 packets.
EncryptionPassword	The password used for SNMPv3 privacy.
ErrorDescription	Description of the status code for the last SNMP packet received by the class.
ErrorIndex	Index of the first variable (object) that caused an error from the last SNMP response.
ErrorStatus	Status code for the last SNMP packet received by the class.
LocalEngineId	The Engine Id of the SNMP Manager.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The port in the local host where the SNMP Manager is bound to.
Objects	The objects in the current request.
RemoteEngineBoots	The remote engine boots (SNMPv3).
RemoteEngineId	The Engine Id of the remote agent.
RemoteEngineTime	The remote engine time (SNMPv3).
RemoteHost	The address of the remote host. Domain names are resolved to IP addresses.
RemotePort	The port where the remote SNMP agent is listening.
RequestId	The request-id to mark outgoing packets with.
SNMPVersion	Version of SNMP used for outgoing requests.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLAuthenticateClients	If set to True, the server asks the client(s) for a certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLEnabled	Whether DTLS is enabled.
SSLServerCert	The server certificate for the last established connection.
StoreWalkObjects	Tells the class whether or not to store returned objects.
Timeout	This property includes the timeout for the class.
User	The user name used for SNMPv3 authentication.
WalkLimit	The limit of oid's returned in a walk.

Method List

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


Activate	Activates the class.
Config	Sets or retrieves a configuration setting.
Deactivate	Deactivates the class.
Discover	Performs SNMPv3 discovery.
DoEvents	This method processes events from the internal message queue.
HashPasswords	Hashes all passwords in the cache.
Interrupt	This method interrupts the current method.
Reset	Clears the object arrays.
SendGetBulkRequest	Send a GetBulkRequest packet.
SendGetNextRequest	Send GetNextRequest packet.
SendGetRequest	Send GetRequest packet.
SendInformRequest	Send an InformRequest packet.
SendSetRequest	Send Set Request packet.
Value	Returns the value corresponding to an OID.
Walk	Does an SNMP walk starting with the specified oid.

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.


BadPacket	Fired for erroneous and/or malformed messages.
Connected	Fired immediately after a connection completes (or fails).
Disconnected	Fired when a connection is closed.
DiscoveryRequest	Fired when an SNMPv3 discovery packet is received.
DiscoveryResponse	Fired when an SNMPv3 discovery response is received.
Error	Fired when information is available about errors during data delivery.
HashPassword	Fired before and after a password is hashed.
InformRequest	Fired when an InformRequest packet is received.
PacketTrace	Fired for every packet sent or received.
ReadyToSend	Fired when the class is ready to send data.
Report	Fired when a Report packet is received.
Response	Fired when a GetResponse packet is received.
SSLClientAuthentication	Fired when the client presents its credentials to the server.
SSLServerAuthentication	Fires when connecting to the server.
SSLStatus	Shows the progress of the secure connection.
Trap	Fired when a SNMP trap packet is received.

Config Settings

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


AllowSingleStepDiscovery	Whether to allow discovery to be completed in a single step.
CheckMessageOrigin	Whether to match the origin IP address when receiving responses.
CheckSNMPVersion	Whether to check the version of incoming packets.
CompatibilityMode	Whether to operate the class in a specific compatibility mode.
ContextEngineId	Sets the context engine id of the SNMP entity.
ContextName	Sets the context name of the SNMP entity.
DecryptLogPackets	Whether to decrypt logged packets.
ForceLocalPort	Forces the class to bind to a specific port.
IgnoreDuplicateResponse	Whether to ignore duplicate responses.
IgnorePortMismatch	Whether to check if the port matches when a response is received.
IncomingContextEngineId	The engine Id of the received packet.
IncomingContextName	The context name of the received packet.
MsgMaxSize	The maximum supported message size.
SourceAddress	The source address of the received packet.
SourcePort	The source port of the received packet.
TimeoutInMilliseconds	The timeout is treated as milliseconds.
WalkInsideRange	Stops the SNMP walk if the OID value returned from an agent is outside the table.
WalkStartOID	Specifies the OID to be used when a Walk is performed.
CaptureIPPacketInfo	Used to capture the packet information.
DelayHostResolution	Whether the hostname is resolved when RemoteHost is set.
DestinationAddress	Used to get the destination address from the packet information.
DontFragment	Used to set the Don't Fragment flag of outgoing packets.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxPacketSize	The maximum length of the packets that can be received.
QOSDSCPValue	Used to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficType	Used to specify QOS/DSCP settings (optional).
ShareLocalPort	If set to True, allows more than one instance of the class to be active on the same local port.
SourceIPAddress	Used to set the source IP address used when sending a packet.
SourceMacAddress	Used to set the source MAC address used when sending a packet.
UseConnection	Determines whether to use a connected socket.
UseIPv6	Whether or not to use IPv6.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

AcceptData Property (SNMPMgr Class)

Enables or disables data reception.

Syntax

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

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

int ipworkssnmp_snmpmgr_getacceptdata(void* lpObj);
int ipworkssnmp_snmpmgr_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 (SNMPMgr Class)

Indicates whether the class is active.

Syntax

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

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

int ipworkssnmp_snmpmgr_getactive(void* lpObj);
int ipworkssnmp_snmpmgr_setactive(void* lpObj, int bActive);

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

Default Value

FALSE

Remarks

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

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

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

This property is not available at design time.

Data Type

Boolean

AuthenticationPassword Property (SNMPMgr Class)

The password used for SNMPv3 authentication.

Syntax

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

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

char* ipworkssnmp_snmpmgr_getauthenticationpassword(void* lpObj);
int ipworkssnmp_snmpmgr_setauthenticationpassword(void* lpObj, const char* lpszAuthenticationPassword);

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

Default Value

Remarks

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

Data Type

String

AuthenticationProtocol Property (SNMPMgr Class)

The authentication protocol used for SNMPv3 packets.

Syntax

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

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

Possible Values

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

int ipworkssnmp_snmpmgr_getauthenticationprotocol(void* lpObj);
int ipworkssnmp_snmpmgr_setauthenticationprotocol(void* lpObj, int iAuthenticationProtocol);

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

Default Value

Remarks

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

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

This property is not available at design time.

Data Type

Integer

Community Property (SNMPMgr Class)

The community string used to authenticate SNMP packets.

Syntax

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

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

char* ipworkssnmp_snmpmgr_getcommunity(void* lpObj);
int ipworkssnmp_snmpmgr_setcommunity(void* lpObj, const char* lpszCommunity);

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

Default Value

"public"

Remarks

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

Typical values are "public" or "private".

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

Data Type

String

EncryptionAlgorithm Property (SNMPMgr Class)

The encryption algorithm used for SNMPv3 packets.

Syntax

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

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

Possible Values

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

int ipworkssnmp_snmpmgr_getencryptionalgorithm(void* lpObj);
int ipworkssnmp_snmpmgr_setencryptionalgorithm(void* lpObj, int iEncryptionAlgorithm);

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

Default Value

Remarks

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


DES (1)	Data Encryption Standard.
AES (2)	Advanced Encryption Standard with key length of 128.
3DES (3)	Triple Data Encryption Standard.
AES192 (4)	Advanced Encryption Standard with key length of 192.
AES256 (5)	Advanced Encryption Standard with key length of 256.

This property is not available at design time.

Data Type

Integer

EncryptionPassword Property (SNMPMgr Class)

The password used for SNMPv3 privacy.

Syntax

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

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

char* ipworkssnmp_snmpmgr_getencryptionpassword(void* lpObj);
int ipworkssnmp_snmpmgr_setencryptionpassword(void* lpObj, const char* lpszEncryptionPassword);

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

Default Value

Remarks

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

Data Type

String

ErrorDescription Property (SNMPMgr Class)

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

Syntax

ANSI (Cross Platform)
char* GetErrorDescription();

Unicode (Windows)
LPWSTR GetErrorDescription();

char* ipworkssnmp_snmpmgr_geterrordescription(void* lpObj);

QString GetErrorDescription();

Default Value

"0"

Remarks

Please refer to the ErrorStatus property for more information.

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

Data Type

String

ErrorIndex Property (SNMPMgr Class)

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

Syntax

ANSI (Cross Platform)
int GetErrorIndex();

Unicode (Windows)
INT GetErrorIndex();

int ipworkssnmp_snmpmgr_geterrorindex(void* lpObj);

int GetErrorIndex();

Default Value

Remarks

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

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

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

Data Type

Integer

ErrorStatus Property (SNMPMgr Class)

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

Syntax

ANSI (Cross Platform)
int GetErrorStatus();

Unicode (Windows)
INT GetErrorStatus();

int ipworkssnmp_snmpmgr_geterrorstatus(void* lpObj);

int GetErrorStatus();

Default Value

Remarks

This property is used in conjunction with the ErrorIndex property, which denotes the index of the variable in error. The ErrorDescription property provides a textual description of the error.

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


0 (noError)	No error.
1 (tooBig)	The response cannot fit in a single SNMP message.
2 (noSuchName)	Variable does not exist.
3 (badValue)	Invalid value or syntax.
4 (readOnly)	Variable is read-only.
5 (genError)	Other error (SNMPv1).
6 (noAccess)	Access denied.
7 (wrongType)	Wrong object type.
8 (wrongLength)	Wrong length.
9 (wrongEncoding)	Wrong encoding.
10 (wrongValue)	Wrong value.
11 (noCreation)	No creation.
12 (inconsistentValue)	Inconsistent value.
13 (resourceUnavailable)	Resource unavailable.
14 (commitFailed)	Commit failed.
15 (undoFailed)	Undo failed.
16 (authorizationError)	Authorization error.
17 (notWritable)	Variable is not writable.
18 (inconsistentName)	Inconsistent name.

The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

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

The default value is 0 (no error).

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

Data Type

Integer

LocalEngineId Property (SNMPMgr Class)

The Engine Id of the SNMP Manager.

Syntax

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_snmpmgr_getlocalengineid(void* lpObj, char** lpLocalEngineId, int* lenLocalEngineId);
int ipworkssnmp_snmpmgr_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 (SNMPMgr Class)

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

Syntax

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

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

char* ipworkssnmp_snmpmgr_getlocalhost(void* lpObj);
int ipworkssnmp_snmpmgr_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

Remarks

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

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

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

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

Data Type

String

LocalPort Property (SNMPMgr Class)

The port in the local host where the SNMP Manager is bound to.

Syntax

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

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

int ipworkssnmp_snmpmgr_getlocalport(void* lpObj);
int ipworkssnmp_snmpmgr_setlocalport(void* lpObj, int iLocalPort);

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

Default Value

Remarks

The LocalPort property must be set before the class is activated (Active is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine. The default port is 0 (random port). If you would like to receive traps, set LocalPort to 162 (standard trap port). However, it is recommended that the SNMPTrapMgr class be used for listening to traps, because SNMPMgr is limited to receiving SNMPv3 traps from a single agent only. SNMPTrapMgr does not have this limitation.

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

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

Data Type

Integer

Objects Property (SNMPMgr Class)

The objects in the current request.

Syntax

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

int ipworkssnmp_snmpmgr_getobjcount(void* lpObj);
int ipworkssnmp_snmpmgr_setobjcount(void* lpObj, int iObjCount);

int ipworkssnmp_snmpmgr_getobjtype(void* lpObj, int objindex);
int ipworkssnmp_snmpmgr_setobjtype(void* lpObj, int objindex, int iObjType);

char* ipworkssnmp_snmpmgr_getobjid(void* lpObj, int objindex);
int ipworkssnmp_snmpmgr_setobjid(void* lpObj, int objindex, const char* lpszObjId);

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

int ipworkssnmp_snmpmgr_getobjvalue(void* lpObj, int objindex, char** lpObjValue, int* lenObjValue);
int ipworkssnmp_snmpmgr_setobjvalue(void* lpObj, int objindex, const char* lpObjValue, int lenObjValue);

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

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

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

QString GetObjTypeString(int iObjIndex);

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

Remarks

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

Data Type

IPWorksSNMPSNMPObject

RemoteEngineBoots Property (SNMPMgr Class)

The remote engine boots (SNMPv3).

Syntax

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

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

int ipworkssnmp_snmpmgr_getremoteengineboots(void* lpObj);
int ipworkssnmp_snmpmgr_setremoteengineboots(void* lpObj, int iRemoteEngineBoots);

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

Default Value

Remarks

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

Data Type

Integer

RemoteEngineId Property (SNMPMgr Class)

The Engine Id of the remote agent.

Syntax

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

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

int ipworkssnmp_snmpmgr_getremoteengineid(void* lpObj, char** lpRemoteEngineId, int* lenRemoteEngineId);
int ipworkssnmp_snmpmgr_setremoteengineid(void* lpObj, const char* lpRemoteEngineId, int lenRemoteEngineId);

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

Default Value

Remarks

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

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

Data Type

Binary String

RemoteEngineTime Property (SNMPMgr Class)

The remote engine time (SNMPv3).

Syntax

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

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

int ipworkssnmp_snmpmgr_getremoteenginetime(void* lpObj);
int ipworkssnmp_snmpmgr_setremoteenginetime(void* lpObj, int iRemoteEngineTime);

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

Default Value

Remarks

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

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

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

Data Type

Integer

RemoteHost Property (SNMPMgr Class)

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

Syntax

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

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

char* ipworkssnmp_snmpmgr_getremotehost(void* lpObj);
int ipworkssnmp_snmpmgr_setremotehost(void* lpObj, const char* lpszRemoteHost);

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

Default Value

Remarks

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

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

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

Data Type

String

RemotePort Property (SNMPMgr Class)

The port where the remote SNMP agent is listening.

Syntax

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

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

int ipworkssnmp_snmpmgr_getremoteport(void* lpObj);
int ipworkssnmp_snmpmgr_setremoteport(void* lpObj, int iRemotePort);

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

Default Value

161

Remarks

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

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

Data Type

Integer

RequestId Property (SNMPMgr Class)

The request-id to mark outgoing packets with.

Syntax

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

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

int ipworkssnmp_snmpmgr_getrequestid(void* lpObj);
int ipworkssnmp_snmpmgr_setrequestid(void* lpObj, int iRequestId);

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

Default Value

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

Version of SNMP used for outgoing requests.

Syntax

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

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

Possible Values

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

int ipworkssnmp_snmpmgr_getsnmpversion(void* lpObj);
int ipworkssnmp_snmpmgr_setsnmpversion(void* lpObj, int iSNMPVersion);

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

Default Value

Remarks

This property takes one of the following values:


snmpverV1 (1)	SNMP Version 1.
snmpverV2c (2)	SNMP Version 2c.
snmpverV3 (3)	SNMP Version 3.

Data Type

Integer

SSLAcceptServerCert Property (SNMPMgr Class)

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

Syntax

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

char* ipworkssnmp_snmpmgr_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertfingerprint(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertissuer(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertprivatekey(void* lpObj);

int ipworkssnmp_snmpmgr_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertpublickey(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworkssnmp_snmpmgr_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertserialnumber(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworkssnmp_snmpmgr_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworkssnmp_snmpmgr_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworkssnmp_snmpmgr_getsslacceptservercertstorepassword(void* lpObj);
int ipworkssnmp_snmpmgr_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworkssnmp_snmpmgr_getsslacceptservercertstoretype(void* lpObj);
int ipworkssnmp_snmpmgr_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworkssnmp_snmpmgr_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertusage(void* lpObj);

int ipworkssnmp_snmpmgr_getsslacceptservercertusageflags(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertversion(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslacceptservercertsubject(void* lpObj);
int ipworkssnmp_snmpmgr_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworkssnmp_snmpmgr_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworkssnmp_snmpmgr_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

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

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

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

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

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

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

Remarks

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

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

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

Data Type

IPWorksSNMPCertificate

SSLAuthenticateClients Property (SNMPMgr Class)

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

Syntax

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

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

int ipworkssnmp_snmpmgr_getsslauthenticateclients(void* lpObj);
int ipworkssnmp_snmpmgr_setsslauthenticateclients(void* lpObj, int bSSLAuthenticateClients);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

SSLCert Property (SNMPMgr Class)

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

Syntax

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

char* ipworkssnmp_snmpmgr_getsslcerteffectivedate(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertexpirationdate(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertextendedkeyusage(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertfingerprint(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertfingerprintsha1(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertfingerprintsha256(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertissuer(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertprivatekey(void* lpObj);

int ipworkssnmp_snmpmgr_getsslcertprivatekeyavailable(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertprivatekeycontainer(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertpublickey(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertpublickeyalgorithm(void* lpObj);

int ipworkssnmp_snmpmgr_getsslcertpublickeylength(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertserialnumber(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertsignaturealgorithm(void* lpObj);

int ipworkssnmp_snmpmgr_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworkssnmp_snmpmgr_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworkssnmp_snmpmgr_getsslcertstorepassword(void* lpObj);
int ipworkssnmp_snmpmgr_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworkssnmp_snmpmgr_getsslcertstoretype(void* lpObj);
int ipworkssnmp_snmpmgr_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworkssnmp_snmpmgr_getsslcertsubjectaltnames(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertthumbprintmd5(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertthumbprintsha1(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertthumbprintsha256(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertusage(void* lpObj);

int ipworkssnmp_snmpmgr_getsslcertusageflags(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertversion(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslcertsubject(void* lpObj);
int ipworkssnmp_snmpmgr_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworkssnmp_snmpmgr_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworkssnmp_snmpmgr_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

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

Data Type

IPWorksSNMPCertificate

SSLEnabled Property (SNMPMgr Class)

Whether DTLS is enabled.

Syntax

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

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

int ipworkssnmp_snmpmgr_getsslenabled(void* lpObj);
int ipworkssnmp_snmpmgr_setsslenabled(void* lpObj, int bSSLEnabled);

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

Default Value

FALSE

Remarks

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

This property is not available at design time.

Data Type

Boolean

SSLServerCert Property (SNMPMgr Class)

The server certificate for the last established connection.

Syntax

IPWorksSNMPCertificate* GetSSLServerCert();

char* ipworkssnmp_snmpmgr_getsslservercerteffectivedate(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertexpirationdate(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertextendedkeyusage(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertfingerprint(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertfingerprintsha1(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertfingerprintsha256(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertissuer(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertprivatekey(void* lpObj);

int ipworkssnmp_snmpmgr_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertpublickey(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworkssnmp_snmpmgr_getsslservercertpublickeylength(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertserialnumber(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertsignaturealgorithm(void* lpObj);

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

char* ipworkssnmp_snmpmgr_getsslservercertstorepassword(void* lpObj);

int ipworkssnmp_snmpmgr_getsslservercertstoretype(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertsubjectaltnames(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertthumbprintmd5(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertthumbprintsha1(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertthumbprintsha256(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertusage(void* lpObj);

int ipworkssnmp_snmpmgr_getsslservercertusageflags(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertversion(void* lpObj);

char* ipworkssnmp_snmpmgr_getsslservercertsubject(void* lpObj);

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

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksSNMPCertificate

StoreWalkObjects Property (SNMPMgr Class)

Tells the class whether or not to store returned objects.

Syntax

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

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

int ipworkssnmp_snmpmgr_getstorewalkobjects(void* lpObj);
int ipworkssnmp_snmpmgr_setstorewalkobjects(void* lpObj, int bStoreWalkObjects);

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

Default Value

TRUE

Remarks

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

Data Type

Boolean

Timeout Property (SNMPMgr Class)

This property includes the timeout for the class.

Syntax

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

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

int ipworkssnmp_snmpmgr_gettimeout(void* lpObj);
int ipworkssnmp_snmpmgr_settimeout(void* lpObj, int iTimeout);

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

Default Value

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

User Property (SNMPMgr Class)

The user name used for SNMPv3 authentication.

Syntax

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

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

char* ipworkssnmp_snmpmgr_getuser(void* lpObj);
int ipworkssnmp_snmpmgr_setuser(void* lpObj, const char* lpszUser);

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

Default Value

Remarks

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

Data Type

String

WalkLimit Property (SNMPMgr Class)

The limit of oid's returned in a walk.

Syntax

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

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

int ipworkssnmp_snmpmgr_getwalklimit(void* lpObj);
int ipworkssnmp_snmpmgr_setwalklimit(void* lpObj, int iWalkLimit);

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

Default Value

Remarks

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

Data Type

Integer

Activate Method (SNMPMgr Class)

Activates the class.

Syntax

ANSI (Cross Platform)
int Activate();

Unicode (Windows)
INT Activate();

int ipworkssnmp_snmpmgr_activate(void* lpObj);

int Activate();

Remarks

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

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

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

Error Handling (C++)

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

Config Method (SNMPMgr Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworkssnmp_snmpmgr_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 (SNMPMgr Class)

Deactivates the class.

Syntax

ANSI (Cross Platform)
int Deactivate();

Unicode (Windows)
INT Deactivate();

int ipworkssnmp_snmpmgr_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++)

Discover Method (SNMPMgr Class)

Performs SNMPv3 discovery.

Syntax

ANSI (Cross Platform)
int Discover();

Unicode (Windows)
INT Discover();

int ipworkssnmp_snmpmgr_discover(void* lpObj);

int Discover();

Remarks

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

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

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

Error Handling (C++)

DoEvents Method (SNMPMgr Class)

This method processes events from the internal message queue.

Syntax

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworkssnmp_snmpmgr_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++)

HashPasswords Method (SNMPMgr Class)

Hashes all passwords in the cache.

Syntax

ANSI (Cross Platform)
int HashPasswords();

Unicode (Windows)
INT HashPasswords();

int ipworkssnmp_snmpmgr_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++)

Interrupt Method (SNMPMgr Class)

This method interrupts the current method.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworkssnmp_snmpmgr_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

Reset Method (SNMPMgr Class)

Clears the object arrays.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworkssnmp_snmpmgr_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++)

SendGetBulkRequest Method (SNMPMgr Class)

Send a GetBulkRequest packet.

Syntax

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

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

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

int SendGetBulkRequest(int iNonRepeaters, int iMaxRepetitions);

Remarks

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

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

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

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

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

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

Example (Sending a GetBulk Request)

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

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


1	1.3.6.1.2.1.1.2.0
2	1.3.6.1.2.1.1.4.0
3	1.3.6.1.2.1.1.5.0
4	1.3.6.1.2.1.1.6.0
5	1.3.6.1.2.1.1.7.0

Error Handling (C++)

SendGetNextRequest Method (SNMPMgr Class)

Send GetNextRequest packet.

Syntax

ANSI (Cross Platform)
int SendGetNextRequest();

Unicode (Windows)
INT SendGetNextRequest();

int ipworkssnmp_snmpmgr_sendgetnextrequest(void* lpObj);

int SendGetNextRequest();

Remarks

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

Example (Sending a GetNext Request)

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

Error Handling (C++)

SendGetRequest Method (SNMPMgr Class)

Send GetRequest packet.

Syntax

ANSI (Cross Platform)
int SendGetRequest();

Unicode (Windows)
INT SendGetRequest();

int ipworkssnmp_snmpmgr_sendgetrequest(void* lpObj);

int SendGetRequest();

Remarks

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

Example (Sending a GetRequest)

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

Error Handling (C++)

SendInformRequest Method (SNMPMgr Class)

Send an InformRequest packet.

Syntax

ANSI (Cross Platform)
int SendInformRequest();

Unicode (Windows)
INT SendInformRequest();

int ipworkssnmp_snmpmgr_sendinformrequest(void* lpObj);

int SendInformRequest();

Remarks

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

Error Handling (C++)

SendSetRequest Method (SNMPMgr Class)

Send Set Request packet.

Syntax

ANSI (Cross Platform)
int SendSetRequest();

Unicode (Windows)
INT SendSetRequest();

int ipworkssnmp_snmpmgr_sendsetrequest(void* lpObj);

int SendSetRequest();

Remarks

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

Example (Sending a SetRequest)

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

Error Handling (C++)

Value Method (SNMPMgr Class)

Returns the value corresponding to an OID.

Syntax

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

Unicode (Windows)
LPWSTR Value(LPCWSTR lpszOID);

char* ipworkssnmp_snmpmgr_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++)

Walk Method (SNMPMgr Class)

Does an SNMP walk starting with the specified oid.

Syntax

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

Unicode (Windows)
INT Walk(LPCWSTR lpszTableOid);

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

int Walk(const QString& qsTableOid);

Remarks

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

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

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

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

Error Handling (C++)

BadPacket Event (SNMPMgr Class)

Fired for erroneous and/or malformed messages.

Syntax

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

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


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

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

#define EID_SNMPMGR_BADPACKET 1

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

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

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

Remarks

The full message is provided in the Packet parameter.

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

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

Connected Event (SNMPMgr Class)

Fired immediately after a connection completes (or fails).

Syntax

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

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


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

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

#define EID_SNMPMGR_CONNECTED 2

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

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

// Or, subclass SNMPMgr and override this emitter function.
virtual int FireConnected(SNMPMgrConnectedEventParams *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.

Disconnected Event (SNMPMgr Class)

Fired when a connection is closed.

Syntax

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

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


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

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

#define EID_SNMPMGR_DISCONNECTED 3

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

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

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

Fired when an SNMPv3 discovery packet is received.

Syntax

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


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

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

#define EID_SNMPMGR_DISCOVERYREQUEST 4

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

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

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

Remarks

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

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

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

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

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

DiscoveryResponse Event (SNMPMgr Class)

Fired when an SNMPv3 discovery response is received.

Syntax

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

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


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

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

#define EID_SNMPMGR_DISCOVERYRESPONSE 5

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

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

  int EngineBoots();

  int EngineTime();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

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

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

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

Remarks

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

Error Event (SNMPMgr Class)

Fired when information is available about errors during data delivery.

Syntax

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

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


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

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

#define EID_SNMPMGR_ERROR 6

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

class SNMPMgrErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

HashPassword Event (SNMPMgr Class)

Fired before and after a password is hashed.

Syntax

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

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


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

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

#define EID_SNMPMGR_HASHPASSWORD 7

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

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

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

Remarks

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

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

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

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

InformRequest Event (SNMPMgr Class)

Fired when an InformRequest packet is received.

Syntax

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

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


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

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

#define EID_SNMPMGR_INFORMREQUEST 8

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

class SNMPMgrInformRequestEventParams {
public:
  int RequestId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

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

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

  const QString &ErrorDescription();

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

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

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

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

Remarks

The user in an InformRequest packet (SNMPv3) must match the user in the User property. If not, the request is rejected, and a BadPacket event is fired before InformRequest is fired.

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

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

The MessageId parameter identifies the received request.

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:


0 (noError)	No error.
1 (tooBig)	The response cannot fit in a single SNMP message.
2 (noSuchName)	Variable does not exist.
3 (badValue)	Invalid value or syntax.
4 (readOnly)	Variable is read-only.
5 (genError)	Other error (SNMPv1).
6 (noAccess)	Access denied.
7 (wrongType)	Wrong object type.
8 (wrongLength)	Wrong length.
9 (wrongEncoding)	Wrong encoding.
10 (wrongValue)	Wrong value.
11 (noCreation)	No creation.
12 (inconsistentValue)	Inconsistent value.
13 (resourceUnavailable)	Resource unavailable.
14 (commitFailed)	Commit failed.
15 (undoFailed)	Undo failed.
16 (authorizationError)	Authorization error.
17 (notWritable)	Variable is not writable.
18 (inconsistentName)	Inconsistent name.

The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

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

PacketTrace Event (SNMPMgr Class)

Fired for every packet sent or received.

Syntax

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

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


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

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

#define EID_SNMPMGR_PACKETTRACE 9

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

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

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

Fired when the class is ready to send data.

Syntax

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

typedef struct {
  int reserved;
} SNMPMgrReadyToSendEventParams;


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

typedef struct {
  INT reserved;
} SNMPMgrReadyToSendEventParams;

#define EID_SNMPMGR_READYTOSEND 10

virtual INT IPWORKSSNMP_CALL FireReadyToSend();

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

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

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

Remarks

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

Report Event (SNMPMgr Class)

Fired when a Report packet is received.

Syntax

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


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

#define EID_SNMPMGR_REPORT 11

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

// Or, subclass SNMPMgr and override this emitter function.
virtual int FireReport(SNMPMgrReportEventParams *e) {...}

Remarks

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

Response Event (SNMPMgr Class)

Fired when a GetResponse packet is received.

Syntax

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


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

#define EID_SNMPMGR_RESPONSE 12

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

class SNMPMgrResponseEventParams {
public:
  int RequestId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &SourceAddress();

  int SourcePort();

  int ErrorIndex();

  int ErrorStatus();

  const QString &ErrorDescription();

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

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

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

Remarks

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

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


0 (noError)	No error.
1 (tooBig)	The response cannot fit in a single SNMP message.
2 (noSuchName)	Variable does not exist.
3 (badValue)	Invalid value or syntax.
4 (readOnly)	Variable is read-only.
5 (genError)	Other error (SNMPv1).
6 (noAccess)	Access denied.
7 (wrongType)	Wrong object type.
8 (wrongLength)	Wrong length.
9 (wrongEncoding)	Wrong encoding.
10 (wrongValue)	Wrong value.
11 (noCreation)	No creation.
12 (inconsistentValue)	Inconsistent value.
13 (resourceUnavailable)	Resource unavailable.
14 (commitFailed)	Commit failed.
15 (undoFailed)	Undo failed.
16 (authorizationError)	Authorization error.
17 (notWritable)	Variable is not writable.
18 (inconsistentName)	Inconsistent name.

The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

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

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

SSLClientAuthentication Event (SNMPMgr Class)

Fired when the client presents its credentials to the server.

Syntax

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


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

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

#define EID_SNMPMGR_SSLCLIENTAUTHENTICATION 13

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

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

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

Fires when connecting to the server.

Syntax

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


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

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

#define EID_SNMPMGR_SSLSERVERAUTHENTICATION 14

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

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

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

Shows the progress of the secure connection.

Syntax

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

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


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

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

#define EID_SNMPMGR_SSLSTATUS 15

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

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

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

Remarks

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

RemoteAddress is the IP address of the remote machine.

RemotePort is the port of the remote machine.

Message is the log message.

Trap Event (SNMPMgr Class)

Fired when a SNMP trap packet is received.

Syntax

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

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


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

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

#define EID_SNMPMGR_TRAP 16

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

class SNMPMgrTrapEventParams {
public:
  int RequestId();

  int SNMPVersion();

  const QString &Community();

  const QString &User();

  int SecurityLevel();

  const QString &TrapOID();

  qint64 TimeStamp();

  const QString &SourceAddress();

  int SourcePort();

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

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

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

Remarks

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

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

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

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

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

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

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

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksSNMPCertificate (declared in ipworkssnmp.h)

Remarks

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

The following fields are available:

Fields

EffectiveDate
char* (read-only)
Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
char* (read-only)
Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
char* (read-only)
Default Value: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
char* (read-only)
Default Value: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
char* (read-only)
Default Value: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
char* (read-only)
Default Value: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
char* (read-only)
Default Value: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

PrivateKey
char* (read-only)
Default Value: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
int (read-only)
Default Value: FALSE

Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
char* (read-only)
Default Value: ""

The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
char* (read-only)
Default Value: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
char* (read-only)
Default Value: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)
Default Value: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
char* (read-only)
Default Value: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
char* (read-only)
Default Value: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
char*
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

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

StorePassword
char*
Default Value: ""

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

StoreType
int
Default Value: 0

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 field can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
char* (read-only)
Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
char* (read-only)
Default Value: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
char* (read-only)
Default Value: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
char* (read-only)
Default Value: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
char* (read-only)
Default Value: ""

The text description of UsageFlags.

This value will be one or more of the following strings and will be separated by commas:

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int (read-only)
Default Value: 0

The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
char* (read-only)
Default Value: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
char*
Default Value: ""

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 field 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:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

Encoded
char*
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

Constructors

Certificate()

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

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

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

SNMPObject Type

The current SNMP object.

Syntax

IPWorksSNMPSNMPObject (declared in ipworkssnmp.h)

Remarks

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

The following fields are available:

Fields

ObjectType
int
Default Value: 5

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

The corresponding object id and value are specified by the Oid and Value fields.

Possible object type values include:


otInteger (2)	2
otOctetString (4)	4
otNull (5)	5
otObjectID (6)	6
otIPAddress (64)	64
otCounter32 (65)	65
otGauge32 (66)	66
otTimeTicks (67)	67
otOpaque (68)	68
otNSAP (69)	69
otCounter64 (70)	70
otUnsignedInteger32 (71)	71

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


otNoSuchObject (128)	No such object error.
otNoSuchInstance (129)	No such instance error.
otEndOfMibView (130)	End of MIB View error.

Oid
char*
Default Value: ""

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 Value fields.

Example

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

TypeString
char* (read-only)
Default Value: ""

A string representation of the current object's ObjectType.

The corresponding object id and value are specified by the Oid and Value fields.

Value
char*
Default Value: ""

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

Example

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

Constructors

SNMPObject()

SNMPObject(const char* lpszOid)

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

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

IPWorksSNMPList Type

Syntax

IPWorksSNMPList<T> (declared in ipworkssnmp.h)

Remarks

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

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount(int count) {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

Config Settings (SNMPMgr Class)

The class accepts one or more of the following configuration settings. Configuration 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.

SNMPManager Config Settings

AllowSingleStepDiscovery: Whether to allow discovery to be completed in a single step.

When making a discovery request in SNMPv3 while this setting is set to False (default), the component will send a second discovery request even if the agent responds to the first request with the EngineBoots and EngineTime. If set to True, the component will skip the second request if all the necessary information is returned in the first response.

CheckMessageOrigin: Whether to match the origin IP address when receiving responses.

This setting specifies whether the class matches the source IP address in the response to the destination IP address of the request. When True (default) the class makes sure that response are received from the same IP to which the request was sent. In most cases this does not need to be changed. If there is a specific reason that responses are expected to originate from a different IP from that which the request was sent, this may be set to False. When False the class will not check the origin of received responses.

CheckSNMPVersion: Whether to check the version of incoming packets.

By default only packets matching SNMPVersion can be received. Set this to false to ignore the version of incoming packets. The default is true.

CompatibilityMode: Whether to operate the component in a specific compatibility mode.

This setting will cause the component to operate in a manner different than normal so that it is compatible with third-party products and libraries. The following table lists the possible values for this setting:


0 (default)	Component operates normally for greatest compatibility.
1	Component uses SNMP4j-compatible encryption (AES192 and AES256).
2	Component automatically detects whether to use SNMP4j-compatible encryption (AES192 and AES256). Note: This option is only applicable when receiving packets. If you are using SNMPMgr or sending secure traps, you will need to select either 0 or 1.

ContextEngineId: Sets the context engine id of the SNMP entity.

If set, the context engine id included in the PDU will be set.

ContextName: Sets the context name of the SNMP entity.

If set, the context name included in the PDU will be set.

DecryptLogPackets: Whether to decrypt logged packets.

When set to true this setting will cause the class to decrypt packets logged in PacketTrace. This only applies when using SNMP Version 3. The default is false.

ForceLocalPort: Forces the class to bind to a specific port.

The default value is True, which makes the class throw an error if LocalPort is busy. When ForceLocalPort is set to False and the port is busy, the class silently chooses another random port.

IgnoreDuplicateResponse: Whether to ignore duplicate responses.

In some scenarios an agent may send a duplicate response (identified by it's RequestID). To prevent processing of a duplicate response set this to true. The default is false

IgnorePortMismatch: Whether to check if the port matches when a response is received.

When a response is received, the class will validate that the port in the response is the same as the port in the request. To disable this, set this to True.

IncomingContextEngineId: The engine Id of the received packet.

This setting holds the engine Id of the received packet. This may be queried at any time, including from within an event, and returns the engine Id of the received packet. This is not needed in most cases, but can be used to store the incoming engine Id to send an asynchronous response later. This value is read-only.

IncomingContextName: The context name of the received packet.

This setting holds the context name of the received packet. This may be queried at any time, including from within an event, and returns the context name of the received packet. This is not needed in most cases, but can be used to store the incoming context name to send an asynchronous response later. This value is read-only.

MsgMaxSize: The maximum supported message size.

This setting specifies the maximum supported message size in bytes. This is only applicable when SNMPVersion is set to 3. This corresponds to the "msgMaxSize" field in the request.

SourceAddress: The source address of the received packet.

This setting holds the source address of the received packet. This may be queried at any time, including from within an event, and returns the source address of the received packet. This value is read-only.

SourcePort: The source port of the received packet.

This setting holds the source port of the received packet. This may be queried at any time, including from within an event, and returns the source port of the received packet. This value is read-only.

TimeoutInMilliseconds: The timeout is treated as milliseconds.

Setting TimeoutInMilliseconds to true causes the class to use the value in Timeout as milliseconds instead of seconds, which is the default.

WalkInsideRange: Stops the SNMP walk if the OID value returned from an agent is outside the table.

When WalkInsideRange is set to true the Walk will continue only while the OID Values returned from the agent are greater than the current OID Value. If an object is returned with an OID value that is out of this range it is not added to the Objects collection, the Error event will fire, and Walk will return. The default value is true.

WalkStartOID: Specifies the OID to be used when a Walk is performed.

When this property is set and Walk is called, the first request sent will contain the specified WalkStartOID value. This feature is particularly useful in the case of errors, such as timeouts, that may occur during a Walk. In such a case, you can set WalkStartOID to the last OID returned before the Timeout occurred then call Walk again (using the original tableOID parameter value). This will allow you to continue the Walk where it left off (when the Timeout error occurred).

Note that when StoreWalkObjects is set to true and WalkStartOID is set, the existing entries in Objects will be maintained when Walk is called and new returned objects will be added (just as if no error occurred in the initial Walk call).

UDP Config Settings

CaptureIPPacketInfo: Used to capture the packet information.

If this is set to True, the component will capture the IP packet information.

The default value for this setting is False.

Note: This configuration setting is available only in Windows.

DelayHostResolution: Whether the hostname is resolved when RemoteHost is set.

This configuration setting specifies whether a hostname is resolved immediately when RemoteHost is set. If true the class will resolve the hostname and the IP address will be present in the RemoteHost property. If false, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may be called to manually resolve the value in RemoteHost at any time.

The default value is false.

DestinationAddress: Used to get the destination address from the packet information.

If CaptureIPPacketInfo is set to True, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event.

Note: This configuration setting is available only in Windows.

DontFragment: Used to set the Don't Fragment flag of outgoing packets.

When set to True, packets sent by the class will have the Don't Fragment flag set. The default value is False.

LocalHost: The name of the local host through which connections are initiated or accepted.

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

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the 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 setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the class binds.

This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxPacketSize: The maximum length of the packets that can be received.

This configuration setting specifies the maximum size of the datagrams that the class will accept without truncation.

QOSDSCPValue: Used to specify an arbitrary QOS/DSCP setting (optional).

UseConnection must be True to use this configuration setting. This option allows you to specify an arbitrary DSCP value between 0 and 63. The default is 0. When set to the default value, the component will not set a DSCP value.

Note: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later.

QOSTrafficType: Used to specify QOS/DSCP settings (optional).

UseConnection must be True to use this setting. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).

Note: This configuration setting uses the qWAVE API and is available only on Windows Vista and Windows Server 2008 or above.

Note: QOSTrafficType must be set before setting Active to True.

ShareLocalPort: If set to True, allows more than one instance of the class to be active on the same local port.

This option must be set before the class is activated through the Active property or it will have no effect.

The default value for this setting is False.

SourceIPAddress: Used to set the source IP address used when sending a packet.

This configuration setting can be used to override the source IP address when sending a packet.

Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

SourceMacAddress: Used to set the source MAC address used when sending a packet.

This configuration setting can be used to override the source MAC address when sending a packet.

Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

UseConnection: Determines whether to use a connected socket.

UseConnection specifies whether or not the class should use a connected socket. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional Transmission Control Protocol (TCP) sense. It means only that the class will send and receive data to and from the specified destination.

The default value for this setting is False.

UseIPv6: Whether or not to use IPv6.

By default, the component expects an IPv4 address for local and remote host properties, and it will create an IPv4 socket. To use IPv6 instead, set this to True.

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

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

SNMPMgr Errors

201	Timeout.
301	Bad Object Index when accessing the Obj* properties. Timeout when performing an operation. Check the error description for details.
302	Value exceeds maximum number of objects allowed.
303	The value must be an IP address in dotted format.
305	Unsupported SNMP version.
306	Unknown PDU type.
307	The class is busy performing the current action.
308	Verification failed.
309	Missing password for Verification.
310	Missing signature.
311	Missing remote time.
312	Missing timeout value.
313	Decryption Failed.
314	Missing password for decryption.
315	Not encrypted.
316	Security model not supported.
317	Defective packet
318	Not from bound point.
319	Operation not permitted in current role.
320	Bad packet.
321	Message not authenticated.
322	No such oid.
323	Missing privacy parameter.
324	Bad engine id.
325	Bad time frame.
326	Bad user name.
327	Security level was not accepted.
328	Discovery failed.
329	Incorrect key length.
330	No authentication password supplied.
333	Returned OID was out of range. This is applicable only when WalkInsideRange is set to true.

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

UDP Errors

104	UDP is already Active.
106	You cannot change the LocalPort while the class is Active.
107	You cannot change the LocalHost at this time. A connection is in progress.
109	The class must be Active for this operation.
112	You cannot change MaxPacketSize while the class is Active.
113	You cannot change ShareLocalPort option while the class is Active.
114	You cannot change RemoteHost when UseConnection is set and the class Active.
115	You cannot change RemotePort when UseConnection is set and the class is Active.
116	RemotePort cannot be zero when UseConnection is set. Please specify a valid service port number.
117	You cannot change UseConnection while the class is Active.
118	Message cannot be longer than MaxPacketSize.
119	Message too short.
434	Unable to convert string to selected CodePage.

SSL Errors

270	Cannot load specified security library.
271	Cannot open certificate store.
272	Cannot find specified certificate.
273	Cannot acquire security credentials.
274	Cannot find certificate chain.
275	Cannot verify certificate chain.
276	Error during handshake.
280	Error verifying certificate.
281	Could not find client certificate.
282	Could not find server certificate.
283	Error encrypting data.
284	Error decrypting data.

TCP/IP Errors

10004	[10004] Interrupted system call.
10009	[10009] Bad file number.
10013	[10013] Access denied.
10014	[10014] Bad address.
10022	[10022] Invalid argument.
10024	[10024] Too many open files.
10035	[10035] Operation would block.
10036	[10036] Operation now in progress.
10037	[10037] Operation already in progress.
10038	[10038] Socket operation on nonsocket.
10039	[10039] Destination address required.
10040	[10040] Message is too long.
10041	[10041] Protocol wrong type for socket.
10042	[10042] Bad protocol option.
10043	[10043] Protocol is not supported.
10044	[10044] Socket type is not supported.
10045	[10045] Operation is not supported on socket.
10046	[10046] Protocol family is not supported.
10047	[10047] Address family is not supported by protocol family.
10048	[10048] Address already in use.
10049	[10049] Cannot assign requested address.
10050	[10050] Network is down.
10051	[10051] Network is unreachable.
10052	[10052] Net dropped connection or reset.
10053	[10053] Software caused connection abort.
10054	[10054] Connection reset by peer.
10055	[10055] No buffer space available.
10056	[10056] Socket is already connected.
10057	[10057] Socket is not connected.
10058	[10058] Cannot send after socket shutdown.
10059	[10059] Too many references, cannot splice.
10060	[10060] Connection timed out.
10061	[10061] Connection refused.
10062	[10062] Too many levels of symbolic links.
10063	[10063] File name is too long.
10064	[10064] Host is down.
10065	[10065] No route to host.
10066	[10066] Directory is not empty
10067	[10067] Too many processes.
10068	[10068] Too many users.
10069	[10069] Disc Quota Exceeded.
10070	[10070] Stale NFS file handle.
10071	[10071] Too many levels of remote in path.
10091	[10091] Network subsystem is unavailable.
10092	[10092] WINSOCK DLL Version out of range.
10093	[10093] Winsock is not loaded yet.
11001	[11001] Host not found.
11002	[11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003	[11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004	[11004] Valid name, no data record (check DNS setup).