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.

Method List

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

Event List

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

Config Settings

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

AccessKey Property (AmazonSNS Class)

The Access Key Id for the Amazon Web Services account.

Syntax

• C++
• C
• Qt

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

FirewallAutoDetect Property (AmazonSNS Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

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

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

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (AmazonSNS Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

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

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

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (AmazonSNS Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

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

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

Default Value

""

Remarks

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

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

Data Type

String

FirewallPassword Property (AmazonSNS Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

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

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

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (AmazonSNS Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

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

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

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

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

Data Type

Integer

FirewallUser Property (AmazonSNS Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

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

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

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (AmazonSNS Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworksmq_amazonsns_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

Idle will be False if the component is currently busy (communicating and/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

• C++
• C
• Qt

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

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

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

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

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

Data Type

String

ProxyAuthScheme Property (AmazonSNS Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

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

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

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

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

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

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

If ProxyAuthScheme 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 ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (AmazonSNS Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

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

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

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (AmazonSNS Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

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

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

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (AmazonSNS Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

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

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

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (AmazonSNS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

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

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

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (AmazonSNS Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

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

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

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (AmazonSNS Class)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

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

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

Default Value

""

Remarks

This property contains a user name, if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

SecretKey Property (AmazonSNS Class)

The Secret Access Key for the Amazon Web Services account.

Syntax

• C++
• C
• Qt

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

SSLAcceptServerCertEncoded Property (AmazonSNS Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int ipworksmq_amazonsns_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksmq_amazonsns_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (AmazonSNS Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int ipworksmq_amazonsns_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksmq_amazonsns_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (AmazonSNS Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (AmazonSNS Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (AmazonSNS Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

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

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

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

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

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (AmazonSNS Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (AmazonSNS Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

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

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

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

0

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:

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

SSLServerCertEncoded Property (AmazonSNS Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

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

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

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

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

SubscriptionMarker Property (AmazonSNS Class)

The token identifying the next page of results.

Syntax

• C++
• C
• Qt

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

SubscriptionCount Property (AmazonSNS Class)

The number of records in the Subscription arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSubscriptionCount();

Unicode (Windows)
INT GetSubscriptionCount();

int ipworksmq_amazonsns_getsubscriptioncount(void* lpObj);

int GetSubscriptionCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• SubscriptionArn
• SubscriptionConfirmationWasAuthenticated
• SubscriptionDeliveryPolicy
• SubscriptionEffectiveDeliveryPolicy
• SubscriptionEndpoint
• SubscriptionHasAttributes
• SubscriptionOwner
• SubscriptionProtocol
• SubscriptionTopicArn

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

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

Data Type

Integer

SubscriptionConfirmationWasAuthenticated Property (AmazonSNS Class)

This property reports whether or not the subscription was confirmed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSubscriptionConfirmationWasAuthenticated(int iSubscriptionIndex);

Unicode (Windows)
BOOL GetSubscriptionConfirmationWasAuthenticated(INT iSubscriptionIndex);

int ipworksmq_amazonsns_getsubscriptionconfirmationwasauthenticated(void* lpObj, int subscriptionindex);

bool GetSubscriptionConfirmationWasAuthenticated(int iSubscriptionIndex);

Default Value

FALSE

Remarks

This property reports whether or not the subscription was confirmed.

Note: This property is only applicable after calling GetSubscriptionAttributes.

The SubscriptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

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

Data Type

Boolean

SubscriptionDeliveryPolicy Property (AmazonSNS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSubscriptionDeliveryPolicy(int iSubscriptionIndex);

Unicode (Windows)
LPWSTR GetSubscriptionDeliveryPolicy(INT iSubscriptionIndex);

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

QString GetSubscriptionDeliveryPolicy(int iSubscriptionIndex);

Default Value

""

Remarks

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

Note: This property is only applicable after calling GetSubscriptionAttributes.

The SubscriptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

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

Data Type

String

SubscriptionEffectiveDeliveryPolicy Property (AmazonSNS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSubscriptionEffectiveDeliveryPolicy(int iSubscriptionIndex);

Unicode (Windows)
LPWSTR GetSubscriptionEffectiveDeliveryPolicy(INT iSubscriptionIndex);

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

QString GetSubscriptionEffectiveDeliveryPolicy(int iSubscriptionIndex);

Default Value

""

Remarks

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

Note: This property is only applicable after calling GetSubscriptionAttributes.

The SubscriptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

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

Data Type

String

SubscriptionEndpoint Property (AmazonSNS Class)

This property contains the subscription's endpoint.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSubscriptionEndpoint(int iSubscriptionIndex);

Unicode (Windows)
LPWSTR GetSubscriptionEndpoint(INT iSubscriptionIndex);

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

QString GetSubscriptionEndpoint(int iSubscriptionIndex);

Default Value

""

Remarks

This property contains the subscription's endpoint.

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

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

The SubscriptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

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

Data Type

String

SubscriptionHasAttributes Property (AmazonSNS Class)

This property returns true if the subscription attributes are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSubscriptionHasAttributes(int iSubscriptionIndex);

Unicode (Windows)
BOOL GetSubscriptionHasAttributes(INT iSubscriptionIndex);

int ipworksmq_amazonsns_getsubscriptionhasattributes(void* lpObj, int subscriptionindex);

bool GetSubscriptionHasAttributes(int iSubscriptionIndex);

Default Value

FALSE

Remarks

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

The following properties are applicable after calling GetSubscriptionAttributes:

• SubscriptionConfirmationWasAuthenticated
• SubscriptionDeliveryPolicy
• SubscriptionEffectiveDeliveryPolicy
• SubscriptionOwner
• SubscriptionArn
• SubscriptionTopicArn

The following properties are applicable after calling ListSubscriptions or ListTopicSubscriptions:

• SubscriptionEndpoint
• SubscriptionOwner
• SubscriptionProtocol
• SubscriptionArn
• SubscriptionTopicArn

The SubscriptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

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

Data Type

Boolean

SubscriptionOwner Property (AmazonSNS Class)

The AWS account ID of the subscription's owner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSubscriptionOwner(int iSubscriptionIndex);

Unicode (Windows)
LPWSTR GetSubscriptionOwner(INT iSubscriptionIndex);

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

QString GetSubscriptionOwner(int iSubscriptionIndex);

Default Value

""

Remarks

The AWS account ID of the subscription's owner.

The SubscriptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

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

Data Type

String

SubscriptionProtocol Property (AmazonSNS Class)

This property specifies the protocol used by the subscription.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSubscriptionProtocol(int iSubscriptionIndex);

Unicode (Windows)
INT GetSubscriptionProtocol(INT iSubscriptionIndex);

int ipworksmq_amazonsns_getsubscriptionprotocol(void* lpObj, int subscriptionindex);

int GetSubscriptionProtocol(int iSubscriptionIndex);

Default Value

0

Remarks

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

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

The SubscriptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

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

Data Type

Integer

SubscriptionArn Property (AmazonSNS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSubscriptionArn(int iSubscriptionIndex);

Unicode (Windows)
LPWSTR GetSubscriptionArn(INT iSubscriptionIndex);

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

QString GetSubscriptionArn(int iSubscriptionIndex);

Default Value

""

Remarks

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

The SubscriptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

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

Data Type

String

SubscriptionTopicArn Property (AmazonSNS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSubscriptionTopicArn(int iSubscriptionIndex);

Unicode (Windows)
LPWSTR GetSubscriptionTopicArn(INT iSubscriptionIndex);

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

QString GetSubscriptionTopicArn(int iSubscriptionIndex);

Default Value

""

Remarks

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

The SubscriptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

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

Data Type

String

Timeout Property (AmazonSNS Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

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

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

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

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

Default Value

60

Remarks

If the Timeout property is set to 0, all operations 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.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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

• C++
• C
• Qt

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 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 ListTopics for more details.

This property is not available at design time.

Data Type

String

TopicCount Property (AmazonSNS Class)

The number of records in the Topic arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTopicCount();

Unicode (Windows)
INT GetTopicCount();

int ipworksmq_amazonsns_gettopiccount(void* lpObj);

int GetTopicCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• TopicAccessPolicy
• TopicArn
• TopicDeliveryPolicy
• TopicDisplayName
• TopicEffectiveDeliveryPolicy
• TopicHasAttributes
• TopicOwner
• TopicSubscriptionsConfirmed
• TopicSubscriptionsDeleted
• TopicSubscriptionsPending

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

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

Data Type

Integer

TopicAccessPolicy Property (AmazonSNS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTopicAccessPolicy(int iTopicIndex);

Unicode (Windows)
LPWSTR GetTopicAccessPolicy(INT iTopicIndex);

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

QString GetTopicAccessPolicy(int iTopicIndex);

Default Value

""

Remarks

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

Note: This property is only applicable after calling GetTopicAttributes.

The TopicIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

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

Data Type

String

TopicDeliveryPolicy Property (AmazonSNS Class)

The JSON serialized policy for the topic.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTopicDeliveryPolicy(int iTopicIndex);

Unicode (Windows)
LPWSTR GetTopicDeliveryPolicy(INT iTopicIndex);

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

QString GetTopicDeliveryPolicy(int iTopicIndex);

Default Value

""

Remarks

The JSON serialized policy for the topic.

Note: This property is only applicable after calling GetTopicAttributes.

The TopicIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

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

Data Type

String

TopicDisplayName Property (AmazonSNS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTopicDisplayName(int iTopicIndex);

Unicode (Windows)
LPWSTR GetTopicDisplayName(INT iTopicIndex);

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

QString GetTopicDisplayName(int iTopicIndex);

Default Value

""

Remarks

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

Note: This property is only applicable after calling GetTopicAttributes.

The TopicIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

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

Data Type

String

TopicEffectiveDeliveryPolicy Property (AmazonSNS Class)

This property holds the JSON serialization of the topic's effective delivery policy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTopicEffectiveDeliveryPolicy(int iTopicIndex);

Unicode (Windows)
LPWSTR GetTopicEffectiveDeliveryPolicy(INT iTopicIndex);

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

QString GetTopicEffectiveDeliveryPolicy(int iTopicIndex);

Default Value

""

Remarks

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

Note: This property is only applicable after calling GetTopicAttributes.

The TopicIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

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

Data Type

String

TopicHasAttributes Property (AmazonSNS Class)

This property returns true if the topic attributes are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTopicHasAttributes(int iTopicIndex);

Unicode (Windows)
BOOL GetTopicHasAttributes(INT iTopicIndex);

int ipworksmq_amazonsns_gettopichasattributes(void* lpObj, int topicindex);

bool GetTopicHasAttributes(int iTopicIndex);

Default Value

FALSE

Remarks

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

The following properties are applicable after calling GetTopicAttributes:

• TopicDeliveryPolicy
• TopicDisplayName
• TopicEffectiveDeliveryPolicy
• TopicOwner
• TopicAccessPolicy
• TopicSubscriptionsConfirmed
• TopicSubscriptionsDeleted
• TopicSubscriptionsPending
• TopicArn

The following properties are applicable after calling ListTopics:

• TopicArn

The TopicIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

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

Data Type

Boolean

TopicOwner Property (AmazonSNS Class)

The AWS account ID of the topic's owner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTopicOwner(int iTopicIndex);

Unicode (Windows)
LPWSTR GetTopicOwner(INT iTopicIndex);

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

QString GetTopicOwner(int iTopicIndex);

Default Value

""

Remarks

The AWS account ID of the topic's owner.

Note: This property is only applicable after calling GetTopicAttributes.

The TopicIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

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

Data Type

String

TopicSubscriptionsConfirmed Property (AmazonSNS Class)

The number of confirmed subscriptions to this topic.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTopicSubscriptionsConfirmed(int iTopicIndex);

Unicode (Windows)
INT GetTopicSubscriptionsConfirmed(INT iTopicIndex);

int ipworksmq_amazonsns_gettopicsubscriptionsconfirmed(void* lpObj, int topicindex);

int GetTopicSubscriptionsConfirmed(int iTopicIndex);

Default Value

0

Remarks

The number of confirmed subscriptions to this topic.

Note: This property is only applicable after calling GetTopicAttributes.

The TopicIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

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

Data Type

Integer

TopicSubscriptionsDeleted Property (AmazonSNS Class)

The number of deleted subscriptions on this topic.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTopicSubscriptionsDeleted(int iTopicIndex);

Unicode (Windows)
INT GetTopicSubscriptionsDeleted(INT iTopicIndex);

int ipworksmq_amazonsns_gettopicsubscriptionsdeleted(void* lpObj, int topicindex);

int GetTopicSubscriptionsDeleted(int iTopicIndex);

Default Value

0

Remarks

The number of deleted subscriptions on this topic.

Note: This property is only applicable after calling GetTopicAttributes.

The TopicIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

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

Data Type

Integer

TopicSubscriptionsPending Property (AmazonSNS Class)

The number of pending subscriptions on this topic.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTopicSubscriptionsPending(int iTopicIndex);

Unicode (Windows)
INT GetTopicSubscriptionsPending(INT iTopicIndex);

int ipworksmq_amazonsns_gettopicsubscriptionspending(void* lpObj, int topicindex);

int GetTopicSubscriptionsPending(int iTopicIndex);

Default Value

0

Remarks

The number of pending subscriptions on this topic.

Note: This property is only applicable after calling GetTopicAttributes.

The TopicIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

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

Data Type

Integer

TopicArn Property (AmazonSNS Class)

The Amazon Resource Name (ARN) of the topic.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTopicArn(int iTopicIndex);

Unicode (Windows)
LPWSTR GetTopicArn(INT iTopicIndex);

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

QString GetTopicArn(int iTopicIndex);

Default Value

""

Remarks

The Amazon Resource Name (ARN) of the topic.

The TopicIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TopicCount property.

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

Data Type

String

UseSSL Property (AmazonSNS Class)

Determines if SSL is used when connecting to Amazon.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

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.

CreateTopic Method (AmazonSNS Class)

Creates a new topic.

Syntax

• C++
• C
• Qt

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

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.

DeleteTopic Method (AmazonSNS Class)

Deletes the specified topic.

Syntax

• C++
• C
• Qt

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

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

DoEvents Method (AmazonSNS Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

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

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

GetSubscriptionAttributes Method (AmazonSNS Class)

Retrieves the subscription's attributes.

Syntax

• C++
• C
• Qt

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 Subscription* properties.

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

GetTopicAttributes Method (AmazonSNS Class)

Retrieves the topic's attributes.

Syntax

• C++
• C
• Qt

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 Topic* properties.

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

GetXValue Method (AmazonSNS Class)

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

Syntax

• C++
• C
• Qt

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

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.

Interrupt Method (AmazonSNS Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

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

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

ListSubscriptions Method (AmazonSNS Class)

Lists subscriptions for the current account.

Syntax

• C++
• C
• Qt

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 Subscription* properties 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++)

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

ListTopics Method (AmazonSNS Class)

Lists all topics for the current account.

Syntax

• C++
• C
• Qt

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 Topic* properties 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++)

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

ListTopicSubscriptions Method (AmazonSNS Class)

Lists subscriptions to the specified topic.

Syntax

• C++
• C
• Qt

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 Subscription* properties 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++)

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

Publish Method (AmazonSNS Class)

Publishes a message to the topic.

Syntax

• C++
• C
• Qt

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

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.

PublishCustom Method (AmazonSNS Class)

Publishes a message to the topic.

Syntax

• C++
• C
• Qt

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.

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.

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

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.

RemovePermission Method (AmazonSNS Class)

Removes permissions from a topic.

Syntax

• C++
• C
• Qt

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

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

Reset Method (AmazonSNS Class)

Resets request-related properties.

Syntax

• C++
• C
• Qt

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

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

SendCustomRequest Method (AmazonSNS Class)

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

Syntax

• C++
• C
• Qt

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

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.

SetSubscriptionAttributes Method (AmazonSNS Class)

Sets attributes of the subscription.

Syntax

• C++
• C
• Qt

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

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

SetTopicAttributes Method (AmazonSNS Class)

Sets attributes on the specified topic.

Syntax

• C++
• C
• Qt

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:

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

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

Subscribe Method (AmazonSNS Class)

Request a subscription to the specific topic.

Syntax

• C++
• C
• Qt

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:

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

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

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.

Unsubscribe Method (AmazonSNS Class)

Unsubscribes from the topic.

Syntax

• C++
• C
• Qt

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

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

Error Event (AmazonSNS Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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.

ErrorCode contains an error code and Description 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)

This event fires once for each log message.

Syntax

• C++
• C
• Qt

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

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

• C++
• C
• Qt

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

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

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

SSLStatus Event (AmazonSNS Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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. Used to track the progress of the connection.

SubscriptionList Event (AmazonSNS Class)

Fires with information about the subscription.

Syntax

• C++
• C
• Qt

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:

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

TopicList Event (AmazonSNS Class)

Fires with information about the topic.

Syntax

• C++
• C
• Qt

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.

Config Settings (AmazonSNS Class)

SNS Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

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

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors