AmazonSNS Class

Properties Methods Events Config Settings Errors

The AmazonSNS class provides a simple interface to Amazon's Simple Notification Service (SNS).

Syntax

AmazonSNS

Remarks

The AmazonSNS class allows you to quickly and easily access Amazon's Simple Notification Service (SNS). SNS allows you to create topics and subscriptions for notification purposes.

Before using the class you must first have an AWS account and sign up for the SNS service. To use the class, first set AccessKey and SecretKey.

To create a topic, call CreateTopic. You may manage the topic and its properties with GetTopicAttributes, SetTopicAttributes, and DeleteTopic.

To subscribe to a topic, call Subscribe. To manage a subscription, use GetSubscriptionAttributes, SetSubscriptionAttributes, and Unsubscribe.

Use ListSubscriptions, ListTopicSubscriptions, and ListTopics to list existing topics and subscriptions.

Call Publish or PublishCustom to send a notification on a topic.

Property List

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


AccessKey	The Access Key Id for the Amazon Web Services account.
Firewall	A set of properties related to firewall access.
Idle	The current status of the class.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Proxy	A set of properties related to proxy access.
SecretKey	The Secret Access Key for the Amazon Web Services account.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
SubscriptionMarker	The token identifying the next page of results.
Subscriptions	A collection of subscription details.
Timeout	The timeout for the class.
TopicMarker	The token identifying the next page of results.
Topics	A collection of topic details.
UseSSL	Determines if SSL is used when connecting to Amazon.

Method List

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


AddPermission	Adds permissions to the topic's access control policy.
Config	Sets or retrieves a configuration setting.
ConfirmSubscription	Completes the subscription request.
CreateTopic	Creates a new topic.
DeleteTopic	Deletes the specified topic.
DoEvents	This method processes events from the internal message queue.
GetSubscriptionAttributes	Retrieves the subscription's attributes.
GetTopicAttributes	Retrieves the topic's attributes.
GetXValue	Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .
Interrupt	This method interrupts the current method.
ListSubscriptions	Lists subscriptions for the current account.
ListTopics	Lists all topics for the current account.
ListTopicSubscriptions	Lists subscriptions to the specified topic.
Publish	Publishes a message to the topic.
PublishCustom	Publishes a message to the topic.
RemovePermission	Removes permissions from a topic.
Reset	Resets request-related properties.
SendCustomRequest	Allows the sending of a custom request to an Amazon web service.
SetSubscriptionAttributes	Sets attributes of the subscription.
SetTopicAttributes	Sets attributes on the specified topic.
Subscribe	Request a subscription to the specific topic.
Unsubscribe	Unsubscribes from the topic.

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.


Error	Fired when information is available about errors during data delivery.
Log	Fired once for each log message.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.
SubscriptionList	Fires with information about the subscription.
TopicList	Fires with information about the topic.

Config Settings

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


APIVersion	Service's API version.
HTTPMethod	Specifies the HTTP method to use when sending a custom request.
IsSubscriptionPaged	Whether or not all subscriptions were returned by the last listing.
IsTopicPaged	Whether or not all topics were returned by the last listing.
JSONMessage	A custom JSON message to be published.
MessageAttributeCount	The number of message attributes.
MessageAttributeDataType[i]	The data type of the message attribute.
MessageAttributeName[i]	The name of the message attribute.
MessageAttributeValue[i]	The value of the message attribute.
PhoneNumber	The phone number to which you want to deliver an SMS message. Use E.164 format.
SignatureVersion	The version of signature used.
SignCustomRequest	Tells the class to sign the outgoing request.
TargetArn	The TargetArn when publishing a message.
TransferredData	Returns the entire XML response received from the server.
URL	If set, the default URL will be overridden by this value.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the class.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusCode	The status code of the last response from the server.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the class.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCount	The number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
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.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
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.

AccessKey Property (AmazonSNS Class)

The Access Key Id for the Amazon Web Services account.

Syntax

ANSI (Cross Platform)
char* GetAccessKey();
int SetAccessKey(const char* lpszAccessKey);

Unicode (Windows)
LPWSTR GetAccessKey();
INT SetAccessKey(LPCWSTR lpszAccessKey);

char* ipworksmq_amazonsns_getaccesskey(void* lpObj);
int ipworksmq_amazonsns_setaccesskey(void* lpObj, const char* lpszAccessKey);

QString GetAccessKey();
int SetAccessKey(QString qsAccessKey);

Default Value

Remarks

This is the username for the Amazon Web Services account. No two accounts may have the same Access Key. This is used along with the SecretKey to authenticate with Amazon servers.

Data Type

String

Firewall Property (AmazonSNS Class)

A set of properties related to firewall access.

Syntax

IPWorksMQFirewall* GetFirewall();
int SetFirewall(IPWorksMQFirewall* val);

int ipworksmq_amazonsns_getfirewallautodetect(void* lpObj);
int ipworksmq_amazonsns_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworksmq_amazonsns_getfirewalltype(void* lpObj);
int ipworksmq_amazonsns_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworksmq_amazonsns_getfirewallhost(void* lpObj);
int ipworksmq_amazonsns_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworksmq_amazonsns_getfirewallpassword(void* lpObj);
int ipworksmq_amazonsns_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworksmq_amazonsns_getfirewallport(void* lpObj);
int ipworksmq_amazonsns_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworksmq_amazonsns_getfirewalluser(void* lpObj);
int ipworksmq_amazonsns_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

IPWorksMQFirewall

Idle Property (AmazonSNS Class)

The current status of the class.

Syntax

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworksmq_amazonsns_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalHost Property (AmazonSNS 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* ipworksmq_amazonsns_getlocalhost(void* lpObj);
int ipworksmq_amazonsns_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

Proxy Property (AmazonSNS Class)

A set of properties related to proxy access.

Syntax

IPWorksMQProxy* GetProxy();
int SetProxy(IPWorksMQProxy* val);

int ipworksmq_amazonsns_getproxyauthscheme(void* lpObj);
int ipworksmq_amazonsns_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int ipworksmq_amazonsns_getproxyautodetect(void* lpObj);
int ipworksmq_amazonsns_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* ipworksmq_amazonsns_getproxypassword(void* lpObj);
int ipworksmq_amazonsns_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int ipworksmq_amazonsns_getproxyport(void* lpObj);
int ipworksmq_amazonsns_setproxyport(void* lpObj, int iProxyPort);

char* ipworksmq_amazonsns_getproxyserver(void* lpObj);
int ipworksmq_amazonsns_setproxyserver(void* lpObj, const char* lpszProxyServer);

int ipworksmq_amazonsns_getproxyssl(void* lpObj);
int ipworksmq_amazonsns_setproxyssl(void* lpObj, int iProxySSL);

char* ipworksmq_amazonsns_getproxyuser(void* lpObj);
int ipworksmq_amazonsns_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

IPWorksMQProxy

SecretKey Property (AmazonSNS Class)

The Secret Access Key for the Amazon Web Services account.

Syntax

ANSI (Cross Platform)
char* GetSecretKey();
int SetSecretKey(const char* lpszSecretKey);

Unicode (Windows)
LPWSTR GetSecretKey();
INT SetSecretKey(LPCWSTR lpszSecretKey);

char* ipworksmq_amazonsns_getsecretkey(void* lpObj);
int ipworksmq_amazonsns_setsecretkey(void* lpObj, const char* lpszSecretKey);

QString GetSecretKey();
int SetSecretKey(QString qsSecretKey);

Default Value

Remarks

This property describes the secret key to the Amazon account. It should not be shared with others. The SecretKey is used along with the AccessKey in the authentication process with Amazon servers.

Data Type

String

SSLAcceptServerCert Property (AmazonSNS Class)

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

Syntax

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

char* ipworksmq_amazonsns_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertissuer(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertprivatekey(void* lpObj);

int ipworksmq_amazonsns_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertpublickey(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksmq_amazonsns_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksmq_amazonsns_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksmq_amazonsns_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksmq_amazonsns_getsslacceptservercertstorepassword(void* lpObj);
int ipworksmq_amazonsns_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksmq_amazonsns_getsslacceptservercertstoretype(void* lpObj);
int ipworksmq_amazonsns_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksmq_amazonsns_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertusage(void* lpObj);

int ipworksmq_amazonsns_getsslacceptservercertusageflags(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertversion(void* lpObj);

char* ipworksmq_amazonsns_getsslacceptservercertsubject(void* lpObj);
int ipworksmq_amazonsns_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksmq_amazonsns_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksmq_amazonsns_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

IPWorksMQCertificate

SSLCert Property (AmazonSNS Class)

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

Syntax

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

char* ipworksmq_amazonsns_getsslcerteffectivedate(void* lpObj);

char* ipworksmq_amazonsns_getsslcertexpirationdate(void* lpObj);

char* ipworksmq_amazonsns_getsslcertextendedkeyusage(void* lpObj);

char* ipworksmq_amazonsns_getsslcertfingerprint(void* lpObj);

char* ipworksmq_amazonsns_getsslcertfingerprintsha1(void* lpObj);

char* ipworksmq_amazonsns_getsslcertfingerprintsha256(void* lpObj);

char* ipworksmq_amazonsns_getsslcertissuer(void* lpObj);

char* ipworksmq_amazonsns_getsslcertprivatekey(void* lpObj);

int ipworksmq_amazonsns_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksmq_amazonsns_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksmq_amazonsns_getsslcertpublickey(void* lpObj);

char* ipworksmq_amazonsns_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksmq_amazonsns_getsslcertpublickeylength(void* lpObj);

char* ipworksmq_amazonsns_getsslcertserialnumber(void* lpObj);

char* ipworksmq_amazonsns_getsslcertsignaturealgorithm(void* lpObj);

int ipworksmq_amazonsns_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksmq_amazonsns_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksmq_amazonsns_getsslcertstorepassword(void* lpObj);
int ipworksmq_amazonsns_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksmq_amazonsns_getsslcertstoretype(void* lpObj);
int ipworksmq_amazonsns_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksmq_amazonsns_getsslcertsubjectaltnames(void* lpObj);

char* ipworksmq_amazonsns_getsslcertthumbprintmd5(void* lpObj);

char* ipworksmq_amazonsns_getsslcertthumbprintsha1(void* lpObj);

char* ipworksmq_amazonsns_getsslcertthumbprintsha256(void* lpObj);

char* ipworksmq_amazonsns_getsslcertusage(void* lpObj);

int ipworksmq_amazonsns_getsslcertusageflags(void* lpObj);

char* ipworksmq_amazonsns_getsslcertversion(void* lpObj);

char* ipworksmq_amazonsns_getsslcertsubject(void* lpObj);
int ipworksmq_amazonsns_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksmq_amazonsns_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksmq_amazonsns_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

IPWorksMQCertificate

SSLProvider Property (AmazonSNS Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworksmq_amazonsns_getsslprovider(void* lpObj);
int ipworksmq_amazonsns_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (AmazonSNS Class)

The server certificate for the last established connection.

Syntax

IPWorksMQCertificate* GetSSLServerCert();

char* ipworksmq_amazonsns_getsslservercerteffectivedate(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertexpirationdate(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertextendedkeyusage(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertfingerprint(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertfingerprintsha1(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertfingerprintsha256(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertissuer(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertprivatekey(void* lpObj);

int ipworksmq_amazonsns_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertpublickey(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworksmq_amazonsns_getsslservercertpublickeylength(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertserialnumber(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertsignaturealgorithm(void* lpObj);

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

char* ipworksmq_amazonsns_getsslservercertstorepassword(void* lpObj);

int ipworksmq_amazonsns_getsslservercertstoretype(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertsubjectaltnames(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertthumbprintmd5(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertthumbprintsha1(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertthumbprintsha256(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertusage(void* lpObj);

int ipworksmq_amazonsns_getsslservercertusageflags(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertversion(void* lpObj);

char* ipworksmq_amazonsns_getsslservercertsubject(void* lpObj);

int ipworksmq_amazonsns_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

IPWorksMQCertificate

SubscriptionMarker Property (AmazonSNS Class)

The token identifying the next page of results.

Syntax

ANSI (Cross Platform)
char* GetSubscriptionMarker();
int SetSubscriptionMarker(const char* lpszSubscriptionMarker);

Unicode (Windows)
LPWSTR GetSubscriptionMarker();
INT SetSubscriptionMarker(LPCWSTR lpszSubscriptionMarker);

char* ipworksmq_amazonsns_getsubscriptionmarker(void* lpObj);
int ipworksmq_amazonsns_setsubscriptionmarker(void* lpObj, const char* lpszSubscriptionMarker);

QString GetSubscriptionMarker();
int SetSubscriptionMarker(QString qsSubscriptionMarker);

Default Value

Remarks

This token identifies the next set of results to retrieve. This is populated automatically when the results are paged. When the results are not paged, or the last page of results is retrieved, this is automatically set to empty string. See ListSubscriptions for more details.

This property is not available at design time.

Data Type

String

Subscriptions Property (AmazonSNS Class)

A collection of subscription details.

Syntax

IPWorksMQList<IPWorksMQSNSSubscription>* GetSubscriptions();

int ipworksmq_amazonsns_getsubscriptioncount(void* lpObj);

int ipworksmq_amazonsns_getsubscriptionconfirmationwasauthenticated(void* lpObj, int subscriptionindex);

char* ipworksmq_amazonsns_getsubscriptiondeliverypolicy(void* lpObj, int subscriptionindex);

char* ipworksmq_amazonsns_getsubscriptioneffectivedeliverypolicy(void* lpObj, int subscriptionindex);

char* ipworksmq_amazonsns_getsubscriptionendpoint(void* lpObj, int subscriptionindex);

int ipworksmq_amazonsns_getsubscriptionhasattributes(void* lpObj, int subscriptionindex);

char* ipworksmq_amazonsns_getsubscriptionowner(void* lpObj, int subscriptionindex);

int ipworksmq_amazonsns_getsubscriptionprotocol(void* lpObj, int subscriptionindex);

char* ipworksmq_amazonsns_getsubscriptionarn(void* lpObj, int subscriptionindex);

char* ipworksmq_amazonsns_getsubscriptiontopicarn(void* lpObj, int subscriptionindex);

int GetSubscriptionCount();

bool GetSubscriptionConfirmationWasAuthenticated(int iSubscriptionIndex);

QString GetSubscriptionDeliveryPolicy(int iSubscriptionIndex);

QString GetSubscriptionEffectiveDeliveryPolicy(int iSubscriptionIndex);

QString GetSubscriptionEndpoint(int iSubscriptionIndex);

bool GetSubscriptionHasAttributes(int iSubscriptionIndex);

QString GetSubscriptionOwner(int iSubscriptionIndex);

int GetSubscriptionProtocol(int iSubscriptionIndex);

QString GetSubscriptionArn(int iSubscriptionIndex);

QString GetSubscriptionTopicArn(int iSubscriptionIndex);

Remarks

This collection is populated after a call to ListSubscriptions, ListTopicSubscriptions, or GetSubscriptionAttributes and holds details about each of the subscriptions.

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

Data Type

IPWorksMQSNSSubscription

Timeout Property (AmazonSNS Class)

The timeout for the class.

Syntax

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

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

int ipworksmq_amazonsns_gettimeout(void* lpObj);
int ipworksmq_amazonsns_settimeout(void* lpObj, int iTimeout);

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

Default Value

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

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

TopicMarker Property (AmazonSNS Class)

The token identifying the next page of results.

Syntax

ANSI (Cross Platform)
char* GetTopicMarker();
int SetTopicMarker(const char* lpszTopicMarker);

Unicode (Windows)
LPWSTR GetTopicMarker();
INT SetTopicMarker(LPCWSTR lpszTopicMarker);

char* ipworksmq_amazonsns_gettopicmarker(void* lpObj);
int ipworksmq_amazonsns_settopicmarker(void* lpObj, const char* lpszTopicMarker);

QString GetTopicMarker();
int SetTopicMarker(QString qsTopicMarker);

Default Value

Remarks

This property is not available at design time.

Data Type

String

Topics Property (AmazonSNS Class)

A collection of topic details.

Syntax

IPWorksMQList<IPWorksMQSNSTopic>* GetTopics();

int ipworksmq_amazonsns_gettopiccount(void* lpObj);

char* ipworksmq_amazonsns_gettopicaccesspolicy(void* lpObj, int topicindex);

char* ipworksmq_amazonsns_gettopicdeliverypolicy(void* lpObj, int topicindex);

char* ipworksmq_amazonsns_gettopicdisplayname(void* lpObj, int topicindex);

char* ipworksmq_amazonsns_gettopiceffectivedeliverypolicy(void* lpObj, int topicindex);

int ipworksmq_amazonsns_gettopichasattributes(void* lpObj, int topicindex);

char* ipworksmq_amazonsns_gettopicowner(void* lpObj, int topicindex);

int ipworksmq_amazonsns_gettopicsubscriptionsconfirmed(void* lpObj, int topicindex);

int ipworksmq_amazonsns_gettopicsubscriptionsdeleted(void* lpObj, int topicindex);

int ipworksmq_amazonsns_gettopicsubscriptionspending(void* lpObj, int topicindex);

char* ipworksmq_amazonsns_gettopicarn(void* lpObj, int topicindex);

int GetTopicCount();

QString GetTopicAccessPolicy(int iTopicIndex);

QString GetTopicDeliveryPolicy(int iTopicIndex);

QString GetTopicDisplayName(int iTopicIndex);

QString GetTopicEffectiveDeliveryPolicy(int iTopicIndex);

bool GetTopicHasAttributes(int iTopicIndex);

QString GetTopicOwner(int iTopicIndex);

int GetTopicSubscriptionsConfirmed(int iTopicIndex);

int GetTopicSubscriptionsDeleted(int iTopicIndex);

int GetTopicSubscriptionsPending(int iTopicIndex);

QString GetTopicArn(int iTopicIndex);

Remarks

This collection is populated after a call to ListTopics, or GetTopicAttributes and holds details about each of the topics.

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

Data Type

IPWorksMQSNSTopic

UseSSL Property (AmazonSNS Class)

Determines if SSL is used when connecting to Amazon.

Syntax

ANSI (Cross Platform)
int GetUseSSL();
int SetUseSSL(int bUseSSL);

Unicode (Windows)
BOOL GetUseSSL();
INT SetUseSSL(BOOL bUseSSL);

int ipworksmq_amazonsns_getusessl(void* lpObj);
int ipworksmq_amazonsns_setusessl(void* lpObj, int bUseSSL);

bool GetUseSSL();
int SetUseSSL(bool bUseSSL);

Default Value

FALSE

Remarks

Use this property to specify whether or not the component uses SSL to connect with Amazon SNS servers.

This property is not available at design time.

Data Type

Boolean

AddPermission Method (AmazonSNS Class)

Adds permissions to the topic's access control policy.

Syntax

ANSI (Cross Platform)
int AddPermission(const char* lpszTopicArn, const char* lpszPolicyLabel, const char* lpszAWSAccountIds, const char* lpszActionNames);

Unicode (Windows)
INT AddPermission(LPCWSTR lpszTopicArn, LPCWSTR lpszPolicyLabel, LPCWSTR lpszAWSAccountIds, LPCWSTR lpszActionNames);

int ipworksmq_amazonsns_addpermission(void* lpObj, const char* lpszTopicArn, const char* lpszPolicyLabel, const char* lpszAWSAccountIds, const char* lpszActionNames);

int AddPermission(const QString& qsTopicArn, const QString& qsPolicyLabel, const QString& qsAWSAccountIds, const QString& qsActionNames);

Remarks

This method may be used to add a statement to the topic's access control policy.

TopicArn specifies the topic.

PolicyLabel should be set to a unique identifier for the new policy statement.

AWSAccountIds is a comma separated list of AWS account IDs of users who will be granted access to the specified actions. The users must have an AWS account, but do not need to be signed up for the SNS service.

ActionNames is a comma separated list of actions that corresponds to the AWS account IDs specified in AWSAccountIds. Possible values are:

AddPermission
CreateTopic
DeleteTopic
GetSubscriptionAttributes
GetTopicAttributes
ListSubscriptions
ListSubscriptionsByTopic
ListTopics
Publish
RemovePermission
SetSubscriptionAttributes
SetTopicAttributes
Subscribe
Unsubscribe

The AWSAccountIds and ActionNames parameters must have the same number of values. The actions correspond to the account IDs and only one action may be set for one account ID at a time. For instance: component.AddPermission("myTopicArn", "myLabel", "1234567,7654321", "Publish,GetTopicAttributes");

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

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksmq_amazonsns_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.

ConfirmSubscription Method (AmazonSNS Class)

Completes the subscription request.

Syntax

ANSI (Cross Platform)
char* ConfirmSubscription(const char* lpszTopicArn, const char* lpszToken);

Unicode (Windows)
LPWSTR ConfirmSubscription(LPCWSTR lpszTopicArn, LPCWSTR lpszToken);

char* ipworksmq_amazonsns_confirmsubscription(void* lpObj, const char* lpszTopicArn, const char* lpszToken);

QString ConfirmSubscription(const QString& qsTopicArn, const QString& qsToken);

Remarks

This method completes the subscription request. After calling the Subscribe method this method must be used to complete the subscription request (if it could not be completed immediately when Subscribe was called).

Set Token to the confirmation token delivered to the endpoint specified in the call to Subscribe. The TopicArn parameter specifies the topic of the subscription.

This method returns the SubscriptionArn which may be used in further subscription related operation. SubscriptionArn may be used with the following methods:

GetSubscriptionAttributes
SetSubscriptionAttributes
Unsubscribe

Error Handling (C++)

CreateTopic Method (AmazonSNS Class)

Creates a new topic.

Syntax

ANSI (Cross Platform)
char* CreateTopic(const char* lpszName);

Unicode (Windows)
LPWSTR CreateTopic(LPCWSTR lpszName);

char* ipworksmq_amazonsns_createtopic(void* lpObj, const char* lpszName);

QString CreateTopic(const QString& qsName);

Remarks

This method creates a new topic specified by the Name parameter. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

The TopicArn is returned by this method an identifier that is used in other operations on the topic. The TopicArn is required for these methods:

DeleteTopic
GetTopicAttributes
ListTopicSubscriptions
Publish
PublishCustom
RemovePermission
SetTopicAttributes
Subscribe

Error Handling (C++)

DeleteTopic Method (AmazonSNS Class)

Deletes the specified topic.

Syntax

ANSI (Cross Platform)
int DeleteTopic(const char* lpszTopicArn);

Unicode (Windows)
INT DeleteTopic(LPCWSTR lpszTopicArn);

int ipworksmq_amazonsns_deletetopic(void* lpObj, const char* lpszTopicArn);

int DeleteTopic(const QString& qsTopicArn);

Remarks

This method deletes the topic specified by the TopicArn parameter. All subscriptions to this topic will also be deleted. If the topic does not exist, no error is returned by Amazon.

Error Handling (C++)

DoEvents Method (AmazonSNS Class)

This method processes events from the internal message queue.

Syntax

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

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

GetSubscriptionAttributes Method (AmazonSNS Class)

Retrieves the subscription's attributes.

Syntax

ANSI (Cross Platform)
int GetSubscriptionAttributes(const char* lpszSubscriptionArn);

Unicode (Windows)
INT GetSubscriptionAttributes(LPCWSTR lpszSubscriptionArn);

int ipworksmq_amazonsns_getsubscriptionattributes(void* lpObj, const char* lpszSubscriptionArn);

int GetSubscriptionAttributes(const QString& qsSubscriptionArn);

Remarks

This method retrieves the subscription's attributes. The attributes are available through the Subscriptions collection.

Error Handling (C++)

GetTopicAttributes Method (AmazonSNS Class)

Retrieves the topic's attributes.

Syntax

ANSI (Cross Platform)
int GetTopicAttributes(const char* lpszTopicArn);

Unicode (Windows)
INT GetTopicAttributes(LPCWSTR lpszTopicArn);

int ipworksmq_amazonsns_gettopicattributes(void* lpObj, const char* lpszTopicArn);

int GetTopicAttributes(const QString& qsTopicArn);

Remarks

This method topic the subscription's attributes. The topic are available through the Topics collection.

Error Handling (C++)

GetXValue Method (AmazonSNS Class)

Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .

Syntax

ANSI (Cross Platform)
char* GetXValue(const char* lpszXPath);

Unicode (Windows)
LPWSTR GetXValue(LPCWSTR lpszXPath);

char* ipworksmq_amazonsns_getxvalue(void* lpObj, const char* lpszXPath);

QString GetXValue(const QString& qsXPath);

Remarks

This method allows a user to retrieve a valid XPath expression from the HTTP response after calling SendCustomRequest.

Error Handling (C++)

Interrupt Method (AmazonSNS Class)

This method interrupts the current method.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworksmq_amazonsns_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

ListSubscriptions Method (AmazonSNS Class)

Lists subscriptions for the current account.

Syntax

ANSI (Cross Platform)
int ListSubscriptions();

Unicode (Windows)
INT ListSubscriptions();

int ipworksmq_amazonsns_listsubscriptions(void* lpObj);

int ListSubscriptions();

Remarks

This method lists the subscriptions for the current AWS account.

When calling this method all subscriptions for the current AWS account identified by AccessKey and SecretKey will be listed. The SubscriptionList event will fire once for each subscription and the Subscriptions collection will be populated with information about the subscriptions.

If the results are paged the IsSubscriptionPaged setting will return the value "True" and SubscriptionMarker will be populated. You may continue to call this method until IsSubscriptionPaged returns "False" and SubscriptionMarker is empty to retrieve all results.

Error Handling (C++)

ListTopics Method (AmazonSNS Class)

Lists all topics for the current account.

Syntax

ANSI (Cross Platform)
int ListTopics();

Unicode (Windows)
INT ListTopics();

int ipworksmq_amazonsns_listtopics(void* lpObj);

int ListTopics();

Remarks

This method lists all topics for the AWS account specified by AccessKey and SecretKey.

When this method is called the TopicList event will fire once for each topic and the Topics collection will be populated with information about the topics.

If the results are paged the IsTopicPaged setting will return the value "True" and TopicMarker will be populated. You may continue to call this method until IsTopicPaged returns "False" and TopicMarker is empty to retrieve all results.

Error Handling (C++)

ListTopicSubscriptions Method (AmazonSNS Class)

Lists subscriptions to the specified topic.

Syntax

ANSI (Cross Platform)
int ListTopicSubscriptions(const char* lpszTopicArn);

Unicode (Windows)
INT ListTopicSubscriptions(LPCWSTR lpszTopicArn);

int ipworksmq_amazonsns_listtopicsubscriptions(void* lpObj, const char* lpszTopicArn);

int ListTopicSubscriptions(const QString& qsTopicArn);

Remarks

This method lists the subscriptions to the specified topic.

When calling this method the subscriptions to the topic specified by TopicARN will be listed. The SubscriptionList event will fire once for each subscription and the Subscriptions collection will be populated with information about the subscriptions.

Error Handling (C++)

Publish Method (AmazonSNS Class)

Publishes a message to the topic.

Syntax

ANSI (Cross Platform)
char* Publish(const char* lpszTopicArn, const char* lpszSubject, const char* lpszmessage);

Unicode (Windows)
LPWSTR Publish(LPCWSTR lpszTopicArn, LPCWSTR lpszSubject, LPCWSTR lpszmessage);

char* ipworksmq_amazonsns_publish(void* lpObj, const char* lpszTopicArn, const char* lpszSubject, const char* lpszmessage);

QString Publish(const QString& qsTopicArn, const QString& qsSubject, const QString& qsmessage);

Remarks

This method publishes a message to the topic specified by TopicArn.

The Subject parameter is optional and specifies the "Subject" line of the message delivered to e-mail endpoints. Subjects must be ASCII text that begins with a letter, number or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

The Message parameter is the text to send. Messages must be UTF-8 encoded strings at most 64 KB in size (65536 bytes, not 65536 characters).

The same message will be delivered to all subscribers. To send different messages based on the protocol used by the subscription call PublishCustom instead.

The method returns the unique MessageId assigned to the published message. It will be at most 100 characters in length.

Error Handling (C++)

PublishCustom Method (AmazonSNS Class)

Publishes a message to the topic.

Syntax

ANSI (Cross Platform)
char* PublishCustom(const char* lpszTopicArn, const char* lpszSubject, const char* lpszdefaultMessage, const char* lpszemailMessage, const char* lpszemailJsonMessage, const char* lpszhttpMessage, const char* lpszhttpsMessage, const char* lpszsmsMessage, const char* lpszsqsMessage);

Unicode (Windows)
LPWSTR PublishCustom(LPCWSTR lpszTopicArn, LPCWSTR lpszSubject, LPCWSTR lpszdefaultMessage, LPCWSTR lpszemailMessage, LPCWSTR lpszemailJsonMessage, LPCWSTR lpszhttpMessage, LPCWSTR lpszhttpsMessage, LPCWSTR lpszsmsMessage, LPCWSTR lpszsqsMessage);

char* ipworksmq_amazonsns_publishcustom(void* lpObj, const char* lpszTopicArn, const char* lpszSubject, const char* lpszdefaultMessage, const char* lpszemailMessage, const char* lpszemailJsonMessage, const char* lpszhttpMessage, const char* lpszhttpsMessage, const char* lpszsmsMessage, const char* lpszsqsMessage);

QString PublishCustom(const QString& qsTopicArn, const QString& qsSubject, const QString& qsdefaultMessage, const QString& qsemailMessage, const QString& qsemailJsonMessage, const QString& qshttpMessage, const QString& qshttpsMessage, const QString& qssmsMessage, const QString& qssqsMessage);

Remarks

This method may be used instead of Publish to specify different messages depending on the protocol used by the subscription.

TopicArn specifies the topic.

DefaultMessage will be used for any protocol that is not specifically assigned a message. If empty string is specified for any other message parameter this value will be used.

EmailMessage, EmailJsonMessage, HttpMessage, HttpsMessage, SmsMessage, and SqsMessage specify messages for the respective protocol. These parameters are all optional. If empty string is specified the DefaultMessage will be used.

The method returns the unique MessageId assigned to the published message. It will be at most 100 characters in length.

Error Handling (C++)

RemovePermission Method (AmazonSNS Class)

Removes permissions from a topic.

Syntax

ANSI (Cross Platform)
int RemovePermission(const char* lpszTopicArn, const char* lpszPolicyLabel);

Unicode (Windows)
INT RemovePermission(LPCWSTR lpszTopicArn, LPCWSTR lpszPolicyLabel);

int ipworksmq_amazonsns_removepermission(void* lpObj, const char* lpszTopicArn, const char* lpszPolicyLabel);

int RemovePermission(const QString& qsTopicArn, const QString& qsPolicyLabel);

Remarks

This method removes permissions specified by the PolicyLabel from the access control policy of the topic specified by TopicArn.

Error Handling (C++)

Reset Method (AmazonSNS Class)

Resets request-related properties.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksmq_amazonsns_reset(void* lpObj);

int Reset();

Remarks

Calling this method will reset the component to the original state.

Error Handling (C++)

SendCustomRequest Method (AmazonSNS Class)

Allows the sending of a custom request to an Amazon web service.

Syntax

ANSI (Cross Platform)
char* SendCustomRequest(const char* lpszUrl, const char* lpszRequestData, const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR SendCustomRequest(LPCWSTR lpszUrl, LPCWSTR lpszRequestData, LPCWSTR lpszOtherHeaders);

char* ipworksmq_amazonsns_sendcustomrequest(void* lpObj, const char* lpszUrl, const char* lpszRequestData, const char* lpszOtherHeaders);

QString SendCustomRequest(const QString& qsUrl, const QString& qsRequestData, const QString& qsOtherHeaders);

Remarks

Allows the sending of a custom request to the Amazon web service. The URL parameter describes the endpoint that is being targeted. The RequestData is set to any data required for the request. The OtherHeaders parameter is used to set any additional headers that should be set for the request.

Error Handling (C++)

SetSubscriptionAttributes Method (AmazonSNS Class)

Sets attributes of the subscription.

Syntax

ANSI (Cross Platform)
int SetSubscriptionAttributes(const char* lpszSubscriptionArn, const char* lpszAttributeValue);

Unicode (Windows)
INT SetSubscriptionAttributes(LPCWSTR lpszSubscriptionArn, LPCWSTR lpszAttributeValue);

int ipworksmq_amazonsns_setsubscriptionattributes(void* lpObj, const char* lpszSubscriptionArn, const char* lpszAttributeValue);

int SetSubscriptionAttributes(const QString& qsSubscriptionArn, const QString& qsAttributeValue);

Remarks

This method is used to set an attribute of the subscription. Currently only the delivery policy may be set.

The SubscriptionArn parameter specifies the Amazon Resource Name (ARN) of the subscription.

The AttributeValue specifies the value to be set. Since the only currently valid attribute is the delivery policy, this is the value of the delivery policy in JSON format, for instance:

{"healthyRetryPolicy": {"minDelayTarget": 1, "maxDelayTarget": 5, "numRetries": 5, "numMaxDelayRetries": 5, "backoffFunction": "linear"}}

Error Handling (C++)

SetTopicAttributes Method (AmazonSNS Class)

Sets attributes on the specified topic.

Syntax

ANSI (Cross Platform)
int SetTopicAttributes(const char* lpszTopicArn, int iAttributeType, const char* lpszAttributeValue);

Unicode (Windows)
INT SetTopicAttributes(LPCWSTR lpszTopicArn, INT iAttributeType, LPCWSTR lpszAttributeValue);

int ipworksmq_amazonsns_settopicattributes(void* lpObj, const char* lpszTopicArn, int iAttributeType, const char* lpszAttributeValue);

int SetTopicAttributes(const QString& qsTopicArn, int iAttributeType, const QString& qsAttributeValue);

Remarks

This method may be used to specify attributes on the specified topic.

TopicArn specifies the topic.

AttributeType determines which attribute is set and AttributeValue specifies the value. The following table provides more information:


AttributeType	AttributeValue
0 (DisplayName)	A human readable name to be used in the "From" field for email based endpoints
1 (AccessPolicy)	A JSON serialized access policy for the topic
2 (DeliveryPolicy)	A JSON serialized delivery policy for the topic

An example access policy is:

{"Version":"2008-10-17","Id":"__default_policy_ID","Statement":[{"Sid":"__default_statement_ID","Effect":"Allow","Principal":{"AWS":"*"},"Action":["SNS:Publish","SNS:RemovePermission","SNS:SetTopicAttributes","SNS:DeleteTopic","SNS:ListSubscriptionsByTopic","SNS:GetTopicAttributes","SNS:Receive","SNS:AddPermission","SNS:Subscribe"],"Resource":"arn:aws:sns:us-east-1:120151960619:TestTopic","Condition":{"StringEquals":{"AWS:SourceOwner":"120151960619"}}},{"Sid":"__console_pub_0","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SNS:Publish","Resource":"arn:aws:sns:us-east-1:120151960619:TestTopic"}]}

An example delivery policy is:

{"http":{"defaultHealthyRetryPolicy": {"minDelayTarget": 1, "maxDelayTarget": 5, "numRetries": 5, "numMaxDelayRetries": 5, "backoffFunction": "linear"}}}

Error Handling (C++)

Subscribe Method (AmazonSNS Class)

Request a subscription to the specific topic.

Syntax

ANSI (Cross Platform)
char* Subscribe(const char* lpszTopicArn, const char* lpszEndpoint, int iEndpointProtocol);

Unicode (Windows)
LPWSTR Subscribe(LPCWSTR lpszTopicArn, LPCWSTR lpszEndpoint, INT iEndpointProtocol);

char* ipworksmq_amazonsns_subscribe(void* lpObj, const char* lpszTopicArn, const char* lpszEndpoint, int iEndpointProtocol);

QString Subscribe(const QString& qsTopicArn, const QString& qsEndpoint, int iEndpointProtocol);

Remarks

This method requests a subscription to the topic specified by TopicArn. If the subscription was created immediately without requiring confirmation the SubscriptionArn will be returned by this method. The SubscriptionArn will begin with "arn:aws:sns". SubscriptionArn may be used with the following methods:

GetSubscriptionAttributes
SetSubscriptionAttributes
Unsubscribe

If the subscription requires confirmation this method returns the subscription status such as "pending confirmation".

The Endpoint and EndpointProtocol parameters specify how the subscription confirmation message is delivered. Possible values for EndpointProtocol are:


0 (email)	message via SMTP
1 (email-json)	JSON-encoded message via SMTP
2 (http)	JSON-encoded message via HTTP POST
3 (https)	JSON-encoded message via HTTPS POST
4 (sms)	message via SMS
5 (sqs)	JSON-encoded message to an Amazon SQS queue

The Endpoint parameter format depends on the chosen EndpointProtocol. Possible formats are:


A valid e-mail address	for use with the "email" protocol
A valid e-mail address	for use with the "email-json" protocol
A URL beginning with "http://"	for use with the "http" protocol
A URL beginning with "https://"	for use with the "https" protocol
A phone number (e.g. 19195447070)	for use with the "sms" protocol
A SQS queue ARN	for use with the "sqs" protocol

Once the subscription confirmation is received by the endpoint owner the ConfirmSubscription method must be called with the confirmation token to complete the subscription.

Note: Confirmation tokens are valid for 3 days.

Error Handling (C++)

Unsubscribe Method (AmazonSNS Class)

Unsubscribes from the topic.

Syntax

ANSI (Cross Platform)
int Unsubscribe(const char* lpszSubscriptionArn);

Unicode (Windows)
INT Unsubscribe(LPCWSTR lpszSubscriptionArn);

int ipworksmq_amazonsns_unsubscribe(void* lpObj, const char* lpszSubscriptionArn);

int Unsubscribe(const QString& qsSubscriptionArn);

Remarks

This method deletes a subscription to a topic. The subscription is identified by the SubscriptionArn parameter.

If the subscription requires authentication for deletion, only the subscription owner or topic owner can unsubscribe. If authentication is not required a cancellation notice is sent to the endpoint, so that the endpoint owner can re-subscribe if the unsubscribe request was unintentional.

Error Handling (C++)

Error Event (AmazonSNS Class)

Fired when information is available about errors during data delivery.

Syntax

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

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


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

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

#define EID_AMAZONSNS_ERROR 1

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

class AmazonSNSErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Log Event (AmazonSNS Class)

Fired once for each log message.

Syntax

ANSI (Cross Platform)
virtual int FireLog(AmazonSNSLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} AmazonSNSLogEventParams;


Unicode (Windows)
virtual INT FireLog(AmazonSNSLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} AmazonSNSLogEventParams;

#define EID_AMAZONSNS_LOG 2

virtual INT IPWORKSMQ_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class AmazonSNSLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

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

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

// Or, subclass AmazonSNS and override this emitter function.
virtual int FireLog(AmazonSNSLogEventParams *e) {...}

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

"Info"
"RequestHeaders"
"ResponseHeaders"
"RequestBody"
"ResponseBody"
"ProxyRequest"
"ProxyResponse"
"FirewallRequest"
"FirewallResponse"

SSLServerAuthentication Event (AmazonSNS Class)

Fired after the server presents its certificate to the client.

Syntax

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

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


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

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

#define EID_AMAZONSNS_SSLSERVERAUTHENTICATION 3

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

class AmazonSNSSSLServerAuthenticationEventParams {
public:
  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(AmazonSNSSSLServerAuthenticationEventParams *e);

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

Remarks

During this event, the client can decide whether or not to continue with the connection process. 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 or not to continue.

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.

SSLStatus Event (AmazonSNS Class)

Fired when secure connection progress messages are available.

Syntax

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

typedef struct {
  const char *Message;
  int reserved;
} AmazonSNSSSLStatusEventParams;


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

typedef struct {
  LPCWSTR Message;
  INT reserved;
} AmazonSNSSSLStatusEventParams;

#define EID_AMAZONSNS_SSLSTATUS 4

virtual INT IPWORKSMQ_CALL FireSSLStatus(LPSTR &lpszMessage);

class AmazonSNSSSLStatusEventParams {
public:
  const QString &Message();

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

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

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

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

SubscriptionList Event (AmazonSNS Class)

Fires with information about the subscription.

Syntax

ANSI (Cross Platform)
virtual int FireSubscriptionList(AmazonSNSSubscriptionListEventParams *e);

typedef struct {
  const char *SubscriptionArn;
  const char *TopicArn;
  const char *Owner;
  const char *Endpoint;
  int Protocol;
  int reserved;
} AmazonSNSSubscriptionListEventParams;


Unicode (Windows)
virtual INT FireSubscriptionList(AmazonSNSSubscriptionListEventParams *e);

typedef struct {
  LPCWSTR SubscriptionArn;
  LPCWSTR TopicArn;
  LPCWSTR Owner;
  LPCWSTR Endpoint;
  INT Protocol;
  INT reserved;
} AmazonSNSSubscriptionListEventParams;

#define EID_AMAZONSNS_SUBSCRIPTIONLIST 5

virtual INT IPWORKSMQ_CALL FireSubscriptionList(LPSTR &lpszSubscriptionArn, LPSTR &lpszTopicArn, LPSTR &lpszOwner, LPSTR &lpszEndpoint, INT &iProtocol);

class AmazonSNSSubscriptionListEventParams {
public:
  const QString &SubscriptionArn();

  const QString &TopicArn();

  const QString &Owner();

  const QString &Endpoint();

  int Protocol();

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

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

// Or, subclass AmazonSNS and override this emitter function.
virtual int FireSubscriptionList(AmazonSNSSubscriptionListEventParams *e) {...}

Remarks

This event fires once for each subscription returned from a call to ListSubscriptions or ListTopicSubscriptions.

SubscriptionArn is the ARN of the subscription.

TopicArn is the ARN of the subscription's topic.

Owner is the subscription's owner.

Protocol is the subscription's protocol. Possible values are:


0 (email)	message via SMTP
1 (email-json)	JSON-encoded message via SMTP
2 (http)	JSON-encoded message via HTTP POST
3 (https)	JSON-encoded message via HTTPS POST
4 (sms)	message via SMS
5 (sqs)	JSON-encoded message to an Amazon SQS queue

Endpoint is the subscription's endpoint. Possible formats are:


A valid e-mail address	for use with the "email" protocol
A valid e-mail address	for use with the "email-json" protocol
A URL beginning with "http://"	for use with the "http" protocol
A URL beginning with "https://"	for use with the "https" protocol
A phone number (e.g. 19195447070)	for use with the "sms" protocol
A SQS queue ARN	for use with the "sqs" protocol

TopicList Event (AmazonSNS Class)

Fires with information about the topic.

Syntax

ANSI (Cross Platform)
virtual int FireTopicList(AmazonSNSTopicListEventParams *e);

typedef struct {
  const char *TopicArn;
  int reserved;
} AmazonSNSTopicListEventParams;


Unicode (Windows)
virtual INT FireTopicList(AmazonSNSTopicListEventParams *e);

typedef struct {
  LPCWSTR TopicArn;
  INT reserved;
} AmazonSNSTopicListEventParams;

#define EID_AMAZONSNS_TOPICLIST 6

virtual INT IPWORKSMQ_CALL FireTopicList(LPSTR &lpszTopicArn);

class AmazonSNSTopicListEventParams {
public:
  const QString &TopicArn();

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

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

// Or, subclass AmazonSNS and override this emitter function.
virtual int FireTopicList(AmazonSNSTopicListEventParams *e) {...}

Remarks

This event fires once for each topic returned from a call to ListTopics.

TopicARN identifies the current topic.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksMQCertificate (declared in ipworksmq.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.

Firewall Type

The firewall the component will connect through.

Syntax

IPWorksMQFirewall (declared in ipworksmq.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

The following fields are available:

Fields

AutoDetect
int
Default Value: FALSE

Whether to automatically detect and use firewall system settings, if available.

FirewallType
int
Default Value: 0

The type of firewall to connect through. The applicable values are as follows:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
char*
Default Value: ""

The name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class fails with an error.

Password
char*
Default Value: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Port
int
Default Value: 0

The Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.

Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
char*
Default Value: ""

A username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Constructors

Firewall()

Proxy Type

The proxy the component will connect to.

Syntax

IPWorksMQProxy (declared in ipworksmq.h)

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

The following fields are available:

Fields

AuthScheme
int
Default Value: 0

The type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the class will attempt basic authentication.

If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If AuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this field will clear the values of User and Password.

AutoDetect
int
Default Value: FALSE

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Password
char*
Default Value: ""

A password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
int
Default Value: 80

The Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.

Server
char*
Default Value: ""

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.

SSL
int
Default Value: 0

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:


psAutomatic (0)	Default setting. If the URL is an `https` URL, the class will use the `psTunnel` option. If the URL is an `http` URL, the class will use the `psNever` option.
psAlways (1)	The connection is always SSL-enabled.
psNever (2)	The connection is not SSL-enabled.
psTunnel (3)	The connection is made through a tunneling (HTTP) proxy.

User
char*
Default Value: ""

A username if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

Proxy()

Proxy(const char* lpszServer, int iPort)

Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)

SNSSubscription Type

This provides details about the subscription.

Syntax

IPWorksMQSNSSubscription (declared in ipworksmq.h)

Remarks

The fields below provide details about the subscription.

The following fields are available:

ConfirmationWasAuthenticated

DeliveryPolicy

EffectiveDeliveryPolicy

Fields

ConfirmationWasAuthenticated
int (read-only)
Default Value: FALSE

This field reports whether or not the subscription was confirmed.

Note: This field is only applicable after calling GetSubscriptionAttributes.

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

This field holds the JSON serialization of the subscription's delivery policy.

Note: This field is only applicable after calling GetSubscriptionAttributes.

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

This field holds the JSON serialization of the subscription's effective delivery policy. This policy takes into account the topic and account defaults.

Note: This field is only applicable after calling GetSubscriptionAttributes.

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

This field contains the subscription's endpoint.

The format of the endpoint depends on the protocol used for the subscription. Possible formats are:


A valid e-mail address	for use with the "email" protocol
A valid e-mail address	for use with the "email-json" protocol
A URL beginning with "http://"	for use with the "http" protocol
A URL beginning with "https://"	for use with the "https" protocol
A phone number (e.g. 19195447070)	for use with the "sms" protocol
A SQS queue ARN	for use with the "sqs" protocol

Note: This field is only applicable after calling ListSubscriptions or ListTopicSubscriptions.

HasAttributes
int (read-only)
Default Value: FALSE

This field returns true if the subscription attributes are available. A subscription's attributes are only returned and parsed after calling GetSubscriptionAttributes. This field serves as an easy way to determine if the subscription's attributes are available.

The following fields are applicable after calling GetSubscriptionAttributes:

ConfirmationWasAuthenticated
DeliveryPolicy
EffectiveDeliveryPolicy
Owner
SubscriptionArn
TopicArn

The following fields are applicable after calling ListSubscriptions or ListTopicSubscriptions:

Endpoint
Owner
Protocol
SubscriptionArn
TopicArn

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

The AWS account ID of the subscription's owner.

Protocol
int (read-only)
Default Value: 0

This field specifies the protocol used by the subscription. Possible values are:


0 (email)	message via SMTP
1 (email-json)	JSON-encoded message via SMTP
2 (http)	JSON-encoded message via HTTP POST
3 (https)	JSON-encoded message via HTTPS POST
4 (sms)	message via SMS
5 (sqs)	JSON-encoded message to an Amazon SQS queue

Note: This field is only applicable after calling ListSubscriptions or ListTopicSubscriptions.

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

The subscription's Amazon Resource Name (ARN) used to identify the subscription.

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

The Amazon Resource Name (ARN) of the topic this subscription is associated with.

Constructors

SNSSubscription()

SNSSubscription(const char* lpszSubscriptionArn, const char* lpszTopicArn, const char* lpszOwner, const char* lpszEndpoint, int iProtocol, int bConfirmationWasAuthenticated, const char* lpszDeliveryPolicy, const char* lpszEffectiveDeliveryPolicy, int bHasAttributes)

SNSTopic Type

This provides details about the topic.

Syntax

IPWorksMQSNSTopic (declared in ipworksmq.h)

Remarks

The fields below provide details about the topic.

The following fields are available:

AccessPolicy

DeliveryPolicy

DisplayName

EffectiveDeliveryPolicy

HasAttributes

Owner

SubscriptionsConfirmed

SubscriptionsDeleted

SubscriptionsPending

TopicArn

Fields

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

This field holds the JSON serialized access control policy for the topic.

Note: This field is only applicable after calling GetTopicAttributes.

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

The JSON serialized policy for the topic.

Note: This field is only applicable after calling GetTopicAttributes.

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

This field holds the name used in the 'From' field for email based endpoints.

Note: This field is only applicable after calling GetTopicAttributes.

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

This field holds the JSON serialization of the topic's effective delivery policy. This policy takes into account the topic and account defaults.

Note: This field is only applicable after calling GetTopicAttributes.

HasAttributes
int (read-only)
Default Value: FALSE

This field returns true if the topic attributes are available. A topic's attributes are only returned and parsed after calling GetTopicAttributes. This field serves as an easy way to determine if the topic's attributes are available.

The following fields are applicable after calling GetTopicAttributes:

DeliveryPolicy
DisplayName
EffectiveDeliveryPolicy
Owner
AccessPolicy
SubscriptionsConfirmed
SubscriptionsDeleted
SubscriptionsPending
TopicArn

The following fields are applicable after calling ListTopics:

TopicArn

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

The AWS account ID of the topic's owner.

Note: This field is only applicable after calling GetTopicAttributes.

SubscriptionsConfirmed
int (read-only)
Default Value: 0

The number of confirmed subscriptions to this topic.

Note: This field is only applicable after calling GetTopicAttributes.

SubscriptionsDeleted
int (read-only)
Default Value: 0

The number of deleted subscriptions on this topic.

Note: This field is only applicable after calling GetTopicAttributes.

SubscriptionsPending
int (read-only)
Default Value: 0

The number of pending subscriptions on this topic.

Note: This field is only applicable after calling GetTopicAttributes.

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

The Amazon Resource Name (ARN) of the topic.

Constructors

SNSTopic()

SNSTopic(const char* lpszTopicArn, const char* lpszOwner, const char* lpszDisplayName, const char* lpszAccessPolicy, const char* lpszDeliveryPolicy, const char* lpszEffectiveDeliveryPolicy, int iSubscriptionsPending, int iSubscriptionsConfirmed, int iSubscriptionsDeleted, int bHasAttributes)

IPWorksMQList Type

Syntax

IPWorksMQList<T> (declared in ipworksmq.h)

Remarks

IPWorksMQList 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 AmazonSNS 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 (AmazonSNS 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.

SNS Config Settings

APIVersion: Service's API version.

This describes the API version as defined by the service of the current protocol. The default is set to the version that the class was designed around, but may be changed to a different version.

Amazon defines each version as the date it was released. An example is: "2009-07-15".

HTTPMethod: Specifies the HTTP method to use when sending a custom request.

The following methods are supported: GET,PUT,HEAD,POST and DELETE and are only used when SendCustomRequest is called. The default value is "" (empty string) in which case the default HTTP methods are used (more details about the default behavior can be found on the SendCustomRequest page).

IsSubscriptionPaged: Whether or not all subscriptions were returned by the last listing.

This configuration may be queried after a call to ListSubscriptions or ListTopicSubscriptions to find out whether or not the server sent all subscriptions in the last listing. If all subscriptions were not listed, the class automatically sets the SubscriptionMarker property to a token used in the next request.

IsTopicPaged: Whether or not all topics were returned by the last listing.

This configuration may be queried after a call to ListTopics to find out whether or not the server sent all topics in the last listing. If all topics were not listed, the class automatically sets the TopicMarker property to a token used in the next request.

JSONMessage: A custom JSON message to be published.

This configuration allows you to publish a custom JSON message instead of the JSON message that is built internally by the class. This configuration is only valid when calling PublishCustom.

MessageAttributeCount: The number of message attributes.

This setting is used to get or set the number of message attributes. This setting is applicable in SQS when calling the CreateMessage and ListMessages methods. This setting is applicable in SNS when calling the PublishMessage method.

MessageAttributeDataType[i]: The data type of the message attribute.

This setting can be used to get or set the data type of the message attribute. This setting is applicable in SQS when calling the CreateMessage and ListMessages methods. This setting is applicable in SNS when calling the PublishMessage method.

Possible values are:

0 (string - default)
1 (number)
2 (binary)

Valid array indices are from 0 to MessageAttributeCount - 1.

MessageAttributeName[i]: The name of the message attribute.

This setting can be used to get or set the message attribute name. This setting is applicable in SQS when calling the CreateMessage and ListMessages methods. This setting is applicable in SNS when calling the PublishMessage method.

Valid array indices are from 0 to MessageAttributeCount - 1.

MessageAttributeValue[i]: The value of the message attribute.

This setting gets or sets the value of the message attribute. This setting is applicable in SQS when calling the CreateMessage and ListMessages methods. This setting is applicable in SNS when calling the PublishMessage method.

Valid array indices are from 0 to MessageAttributeCount - 1.

PhoneNumber: The phone number to which you want to deliver an SMS message. Use E.164 format.

This configuration setting allows you to send an SMS message directly to a phone number. This can be set to an E.164 formatted phone number. When setting this value call Publish with an empty string for the TopicArn parameter. For instance: sns1.Config("PhoneNumber=+19191234567"); sns1.Publish("","","message");

SignatureVersion: The version of signature used.

The signature version used in the request. The default value is "4".

SignCustomRequest: Tells the component to sign the outgoing request.

By default, this configuration is True, and when SendCustomRequest is called the class will sign the specified request to authenticate with the service. If set to False, the request will be sent as is, without signing.

TargetArn: The TargetArn when publishing a message.

This setting specifies the TargetArn when calling Publish. This may be set to a TopicArn or an EndpointArn. When setting this value call Publish with an empty string for the TopicArn parameter. For instance: sns1.Config("TargetArn=myArn"); sns1.Publish("","subject","message");

TransferredData: Returns the entire XML response received from the server.

URL: If set, the default URL will be overridden by this value.

By default, the class uses the service's URL. Setting this config will override this value.

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization: The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL: If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion: The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince: A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel: The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPassword: A password if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort: Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer: Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser: A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders: The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode: The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine: The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData: The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit: The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders: The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest: The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs: Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient: Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

Note: This setting is applicable only to Mac/iOS editions.

UseProxyAutoConfigURL: Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent: Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveRetryCount: The number of keep-alive packets to be sent before the remotehost is considered disconnected.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

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.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir: The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile: Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList: A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData: The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession: Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the class is the same.

SSLCACertFilePaths: The paths to CA certificate files on Unix/Linux.

This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include the following:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when SSLProvider is set to Internalinclude the following:

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");

Possible values when SSLProvider is set to Internal include the following:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default - Client and Server)
TLS1.1	768 (Hex 300) (Default - Client)
TLS1	192 (Hex C0) (Default - Client)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider), please be aware of the following notes:

The platform provider is available only on Windows 11/Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

Note: This configuration setting is applicable only when SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedVersion: Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown certificate authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown certificate authority revocation status.
0x00000800	Ignore unknown root revocation status.
0x00008000	Allow test root certificate.
0x00004000	Trust test root certificate.
0x80000000	Ignore non-matching CN (certificate CN non-matching server name).

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

SSLServerCACerts: A newline separated list of CA certificates to use during SSL server certificate validation.

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

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.

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

SNS Errors

601	An error was returned from the server. Please refer to the error message for additional information.
602	The cryptographic operation failed. Please see the error message for additional information.
603	Invalid Topic index.
604	Invalid Subscription index.
605	Invalid topic attribute type.
606	Invalid subscription attribute type.
607	Invalid subscription protocol value.

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

HTTP Errors

118	Firewall error. The error description contains the detailed message.
143	Busy executing current method.
151	HTTP protocol error. The error message has the server response.
152	No server specified in URL.
153	Specified URLScheme is invalid.
155	Range operation is not supported by server.
156	Invalid cookie index (out of range).
301	Interrupted.
302	Cannot open AttachedFile.

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

TCPClient Errors

100	You cannot change the RemotePort at this time. A connection is in progress.
101	You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102	The RemoteHost address is invalid (0.0.0.0).
104	Already connected. If you want to reconnect, close the current connection first.
106	You cannot change the LocalPort at this time. A connection is in progress.
107	You cannot change the LocalHost at this time. A connection is in progress.
112	You cannot change MaxLineLength at this time. A connection is in progress.
116	RemotePort cannot be zero. Please specify a valid service port number.
117	You cannot change the UseConnection option while the class is active.
135	Operation would block.
201	Timeout.
211	Action impossible in control's present state.
212	Action impossible while not connected.
213	Action impossible while listening.
301	Timeout.
302	Could not open file.
434	Unable to convert string to selected CodePage.
1105	Already connecting. If you want to reconnect, close the current connection first.
1117	You need to connect first.
1119	You cannot change the LocalHost at this time. A connection is in progress.
1120	Connection dropped by remote host.

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