AmazonSQS Class

Properties   Methods   Events   Config Settings   Errors  

The AmazonSQS Class provides an easy interface to Amazon's Simple Queue Service (SQS).

Class Name

IPWorksMQ_AmazonSQS

Procedural Interface

 ipworksmq_amazonsqs_open();
 ipworksmq_amazonsqs_close($res);
 ipworksmq_amazonsqs_register_callback($res, $id, $function);
 ipworksmq_amazonsqs_get_last_error($res);
 ipworksmq_amazonsqs_get_last_error_code($res);
 ipworksmq_amazonsqs_set($res, $id, $index, $value);
 ipworksmq_amazonsqs_get($res, $id, $index);
 ipworksmq_amazonsqs_do_addpermission($res, $queueid, $userlabel, $amazonaccount, $permissionname);
 ipworksmq_amazonsqs_do_changemessagevisibility($res, $queueid, $receipthandle, $visiblitytimeout);
 ipworksmq_amazonsqs_do_config($res, $configurationstring);
 ipworksmq_amazonsqs_do_createmessage($res, $queueid, $message);
 ipworksmq_amazonsqs_do_createqueue($res, $queuename);
 ipworksmq_amazonsqs_do_deletemessage($res, $queueid, $receipthandle);
 ipworksmq_amazonsqs_do_deletequeue($res, $queueid);
 ipworksmq_amazonsqs_do_doevents($res);
 ipworksmq_amazonsqs_do_getqueueattributes($res, $queueid);
 ipworksmq_amazonsqs_do_getxvalue($res, $xpath);
 ipworksmq_amazonsqs_do_interrupt($res);
 ipworksmq_amazonsqs_do_listmessages($res, $queueid);
 ipworksmq_amazonsqs_do_listqueues($res);
 ipworksmq_amazonsqs_do_removepermission($res, $queueid, $userlabel);
 ipworksmq_amazonsqs_do_reset($res);
 ipworksmq_amazonsqs_do_resetheaders($res);
 ipworksmq_amazonsqs_do_sendcustomrequest($res, $url, $requestdata, $otherheaders);
 ipworksmq_amazonsqs_do_setqueueattribute($res, $queueid, $attributename, $attributevalue);

Remarks

The AmazonSQS Class allows you to access Amazon's Simple Queue Service (SQS). SQS allows you to create globally accessible queues on Amazon's servers. These queues can be used by developers to transfer data between distributed application components, without losing messages or requiring each component to always be available. A brief synopsis follows but please refer to Amazon SQS documentation for details.

You will first need to sign up for the SQS service and obtain the AccessKey and SecretKey from Amazon. Then you can start creating queues in your account using CreateQueue. You can then start adding message's to the queue using CreateMessage and retrieve the same using ListMessages.

There are other methods such as ListQueues, DeleteQueue, DeleteMessage etc. that further enable you to manage your SQS queues.

SmoothMQ is also supported. For compatibility with SmoothMQ, APIRequestFormat must be set to 2. Additionally, it is advisable to set ResolveQueueId to true.

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

The Access Key Id for the Amazon Web Services account.

Object Oriented Interface

public function getAccessKey();
public function setAccessKey($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 1 );
ipworksmq_amazonsqs_set($res, 1, $value );

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

AttributesCount Property (IPWorksMQ_AmazonSQS Class)

The number of records in the Attributes arrays.

Object Oriented Interface

public function getAttributesCount();

Procedural Interface

ipworksmq_amazonsqs_get($res, 2 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttributesName
• AttributesValue

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

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

Data Type

Integer

AttributesName Property (IPWorksMQ_AmazonSQS Class)

The name of the attribute.

Object Oriented Interface

public function getAttributesName($attributesindex);

Procedural Interface

ipworksmq_amazonsqs_get($res, 3 , $attributesindex);

Default Value

''

Remarks

The name of the attribute.

The $attributesindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributesCount property.

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

Data Type

String

AttributesValue Property (IPWorksMQ_AmazonSQS Class)

The value of the attribute.

Object Oriented Interface

public function getAttributesValue($attributesindex);

Procedural Interface

ipworksmq_amazonsqs_get($res, 4 , $attributesindex);

Default Value

''

Remarks

The value of the attribute.

The $attributesindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributesCount property.

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

Data Type

String

FirewallAutoDetect Property (IPWorksMQ_AmazonSQS Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 5 );
ipworksmq_amazonsqs_set($res, 5, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (IPWorksMQ_AmazonSQS Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 6 );
ipworksmq_amazonsqs_set($res, 6, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (IPWorksMQ_AmazonSQS Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 7 );
ipworksmq_amazonsqs_set($res, 7, $value );

Default Value

''

Remarks

The name or IP address of the 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 (IPWorksMQ_AmazonSQS Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 8 );
ipworksmq_amazonsqs_set($res, 8, $value );

Default Value

''

Remarks

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

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 9 );
ipworksmq_amazonsqs_set($res, 9, $value );

Default Value

0

Remarks

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

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 10 );
ipworksmq_amazonsqs_set($res, 10, $value );

Default Value

''

Remarks

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

Data Type

String

LocalHost Property (IPWorksMQ_AmazonSQS Class)

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 11 );
ipworksmq_amazonsqs_set($res, 11, $value );

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

MaxMessages Property (IPWorksMQ_AmazonSQS Class)

The maximum number of messages retrieved from the queue.

Object Oriented Interface

public function getMaxMessages();
public function setMaxMessages($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 12 );
ipworksmq_amazonsqs_set($res, 12, $value );

Default Value

1

Remarks

The maximum number of messages retrieved by ListMessages. This is not the number of messages that will be returned, but just the maximum number that will be returned.

Amazon's SQS service dictates that this parameter should be between 1 to 10, all other values are illegal.

Data Type

Integer

MessagesCount Property (IPWorksMQ_AmazonSQS Class)

The number of records in the Messages arrays.

Object Oriented Interface

public function getMessagesCount();

Procedural Interface

ipworksmq_amazonsqs_get($res, 13 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessagesBody
• MessagesId
• MessagesMD5
• MessagesReceiptHandle

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

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

Data Type

Integer

MessagesBody Property (IPWorksMQ_AmazonSQS Class)

The body of the SQS message.

Object Oriented Interface

public function getMessagesBody($messagesindex);

Procedural Interface

ipworksmq_amazonsqs_get($res, 14 , $messagesindex);

Default Value

''

Remarks

The body of the SQS message.

The $messagesindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

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

Data Type

String

MessagesId Property (IPWorksMQ_AmazonSQS Class)

The ID of the SQS message.

Object Oriented Interface

public function getMessagesId($messagesindex);

Procedural Interface

ipworksmq_amazonsqs_get($res, 15 , $messagesindex);

Default Value

''

Remarks

The ID of the SQS message.

The $messagesindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

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

Data Type

String

MessagesMD5 Property (IPWorksMQ_AmazonSQS Class)

The MD5 of the SQS message.

Object Oriented Interface

public function getMessagesMD5($messagesindex);

Procedural Interface

ipworksmq_amazonsqs_get($res, 16 , $messagesindex);

Default Value

''

Remarks

The MD5 of the SQS message.

The $messagesindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

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

Data Type

String

MessagesReceiptHandle Property (IPWorksMQ_AmazonSQS Class)

The Receipt handle of the SQS message.

Object Oriented Interface

public function getMessagesReceiptHandle($messagesindex);

Procedural Interface

ipworksmq_amazonsqs_get($res, 17 , $messagesindex);

Default Value

''

Remarks

The Receipt handle of the SQS message.

The $messagesindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

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

Data Type

String

OtherHeaders Property (IPWorksMQ_AmazonSQS Class)

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 18 );
ipworksmq_amazonsqs_set($res, 18, $value );

Default Value

''

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

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 property with caution. If this property contains invalid headers, HTTP requests may fail.

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

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (IPWorksMQ_AmazonSQS Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 19 );
ipworksmq_amazonsqs_set($res, 19, $value );

Default Value

0

Remarks

The 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 class 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 (IPWorksMQ_AmazonSQS Class)

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

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 20 );
ipworksmq_amazonsqs_set($res, 20, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (IPWorksMQ_AmazonSQS Class)

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

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 21 );
ipworksmq_amazonsqs_set($res, 21, $value );

Default Value

''

Remarks

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

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties 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 (IPWorksMQ_AmazonSQS Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 22 );
ipworksmq_amazonsqs_set($res, 22, $value );

Default Value

80

Remarks

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

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

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 23 );
ipworksmq_amazonsqs_set($res, 23, $value );

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

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 24 );
ipworksmq_amazonsqs_set($res, 24, $value );

Default Value

0

Remarks

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

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

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 25 );
ipworksmq_amazonsqs_set($res, 25, $value );

Default Value

''

Remarks

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

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties 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

QueuePrefix Property (IPWorksMQ_AmazonSQS Class)

QueuePrefix can be used to filter the queues listed.

Object Oriented Interface

public function getQueuePrefix();
public function setQueuePrefix($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 26 );
ipworksmq_amazonsqs_set($res, 26, $value );

Default Value

''

Remarks

Only the queues whose names start with the specified QueuePrefix are listed when ListQueues is called.

Data Type

String

QueuesCount Property (IPWorksMQ_AmazonSQS Class)

The number of records in the Queues arrays.

Object Oriented Interface

public function getQueuesCount();

Procedural Interface

ipworksmq_amazonsqs_get($res, 27 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueuesId
• QueuesUrl

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

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

Data Type

Integer

QueuesId Property (IPWorksMQ_AmazonSQS Class)

The ID of the SQS queue.

Object Oriented Interface

public function getQueuesId($queuesindex);

Procedural Interface

ipworksmq_amazonsqs_get($res, 28 , $queuesindex);

Default Value

''

Remarks

The ID of the SQS queue.

The $queuesindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueuesCount property.

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

Data Type

String

QueuesUrl Property (IPWorksMQ_AmazonSQS Class)

The URL of the SQS queue.

Object Oriented Interface

public function getQueuesUrl($queuesindex);

Procedural Interface

ipworksmq_amazonsqs_get($res, 29 , $queuesindex);

Default Value

''

Remarks

The URL of the SQS queue.

The $queuesindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueuesCount property.

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

Data Type

String

Referer Property (IPWorksMQ_AmazonSQS Class)

This property includes the referer URL/document (optional).

Object Oriented Interface

public function getReferer();
public function setReferer($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 30 );
ipworksmq_amazonsqs_set($res, 30, $value );

Default Value

''

Remarks

If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

This property is not available at design time.

Data Type

String

SecretKey Property (IPWorksMQ_AmazonSQS Class)

The Secret Access Key for the Amazon Web Services account.

Object Oriented Interface

public function getSecretKey();
public function setSecretKey($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 31 );
ipworksmq_amazonsqs_set($res, 31, $value );

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

SSLAcceptServerCertEffectiveDate Property (IPWorksMQ_AmazonSQS Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworksmq_amazonsqs_get($res, 32 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorksMQ_AmazonSQS Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworksmq_amazonsqs_get($res, 33 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorksMQ_AmazonSQS Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworksmq_amazonsqs_get($res, 34 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorksMQ_AmazonSQS Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworksmq_amazonsqs_get($res, 35 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorksMQ_AmazonSQS Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworksmq_amazonsqs_get($res, 36 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorksMQ_AmazonSQS Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworksmq_amazonsqs_get($res, 37 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorksMQ_AmazonSQS Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworksmq_amazonsqs_get($res, 38 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorksMQ_AmazonSQS Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworksmq_amazonsqs_get($res, 39 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorksMQ_AmazonSQS Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworksmq_amazonsqs_get($res, 40 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorksMQ_AmazonSQS Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworksmq_amazonsqs_get($res, 41 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorksMQ_AmazonSQS Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworksmq_amazonsqs_get($res, 42 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorksMQ_AmazonSQS Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksmq_amazonsqs_get($res, 43 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorksMQ_AmazonSQS Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworksmq_amazonsqs_get($res, 44 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorksMQ_AmazonSQS Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworksmq_amazonsqs_get($res, 45 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorksMQ_AmazonSQS Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworksmq_amazonsqs_get($res, 46 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorksMQ_AmazonSQS Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 47 );
ipworksmq_amazonsqs_set($res, 47, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is 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).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorksMQ_AmazonSQS Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 48 );
ipworksmq_amazonsqs_set($res, 48, $value );

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

SSLAcceptServerCertStoreType Property (IPWorksMQ_AmazonSQS Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 49 );
ipworksmq_amazonsqs_set($res, 49, $value );

Default Value

0

Remarks

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

SSLAcceptServerCertSubjectAltNames Property (IPWorksMQ_AmazonSQS Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworksmq_amazonsqs_get($res, 50 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksMQ_AmazonSQS Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworksmq_amazonsqs_get($res, 51 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorksMQ_AmazonSQS Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworksmq_amazonsqs_get($res, 52 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorksMQ_AmazonSQS Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworksmq_amazonsqs_get($res, 53 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorksMQ_AmazonSQS Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworksmq_amazonsqs_get($res, 54 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorksMQ_AmazonSQS Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworksmq_amazonsqs_get($res, 55 );

Default Value

0

Remarks

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

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorksMQ_AmazonSQS Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworksmq_amazonsqs_get($res, 56 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorksMQ_AmazonSQS Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 57 );
ipworksmq_amazonsqs_set($res, 57, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorksMQ_AmazonSQS Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 58 );
ipworksmq_amazonsqs_set($res, 58, $value );

Default Value

''

Remarks

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

SSLCertEffectiveDate Property (IPWorksMQ_AmazonSQS Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksmq_amazonsqs_get($res, 59 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorksMQ_AmazonSQS Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksmq_amazonsqs_get($res, 60 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorksMQ_AmazonSQS Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksmq_amazonsqs_get($res, 61 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorksMQ_AmazonSQS Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksmq_amazonsqs_get($res, 62 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorksMQ_AmazonSQS Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksmq_amazonsqs_get($res, 63 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorksMQ_AmazonSQS Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksmq_amazonsqs_get($res, 64 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorksMQ_AmazonSQS Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksmq_amazonsqs_get($res, 65 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorksMQ_AmazonSQS Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksmq_amazonsqs_get($res, 66 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorksMQ_AmazonSQS Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksmq_amazonsqs_get($res, 67 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorksMQ_AmazonSQS Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksmq_amazonsqs_get($res, 68 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorksMQ_AmazonSQS Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksmq_amazonsqs_get($res, 69 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorksMQ_AmazonSQS Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksmq_amazonsqs_get($res, 70 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorksMQ_AmazonSQS Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksmq_amazonsqs_get($res, 71 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorksMQ_AmazonSQS Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksmq_amazonsqs_get($res, 72 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorksMQ_AmazonSQS Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksmq_amazonsqs_get($res, 73 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorksMQ_AmazonSQS Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 74 );
ipworksmq_amazonsqs_set($res, 74, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is 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).

Data Type

Binary String

SSLCertStorePassword Property (IPWorksMQ_AmazonSQS Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 75 );
ipworksmq_amazonsqs_set($res, 75, $value );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 76 );
ipworksmq_amazonsqs_set($res, 76, $value );

Default Value

0

Remarks

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

SSLCertSubjectAltNames Property (IPWorksMQ_AmazonSQS Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksmq_amazonsqs_get($res, 77 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksMQ_AmazonSQS Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksmq_amazonsqs_get($res, 78 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorksMQ_AmazonSQS Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksmq_amazonsqs_get($res, 79 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorksMQ_AmazonSQS Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksmq_amazonsqs_get($res, 80 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorksMQ_AmazonSQS Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksmq_amazonsqs_get($res, 81 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorksMQ_AmazonSQS Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksmq_amazonsqs_get($res, 82 );

Default Value

0

Remarks

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

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorksMQ_AmazonSQS Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksmq_amazonsqs_get($res, 83 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorksMQ_AmazonSQS Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 84 );
ipworksmq_amazonsqs_set($res, 84, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLCertEncoded Property (IPWorksMQ_AmazonSQS Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 85 );
ipworksmq_amazonsqs_set($res, 85, $value );

Default Value

''

Remarks

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

SSLProvider Property (IPWorksMQ_AmazonSQS Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 86 );
ipworksmq_amazonsqs_set($res, 86, $value );

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 as follows:

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

SSLServerCertEffectiveDate Property (IPWorksMQ_AmazonSQS Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworksmq_amazonsqs_get($res, 87 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorksMQ_AmazonSQS Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworksmq_amazonsqs_get($res, 88 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorksMQ_AmazonSQS Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworksmq_amazonsqs_get($res, 89 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorksMQ_AmazonSQS Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworksmq_amazonsqs_get($res, 90 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorksMQ_AmazonSQS Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworksmq_amazonsqs_get($res, 91 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorksMQ_AmazonSQS Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworksmq_amazonsqs_get($res, 92 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorksMQ_AmazonSQS Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworksmq_amazonsqs_get($res, 93 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorksMQ_AmazonSQS Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworksmq_amazonsqs_get($res, 94 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorksMQ_AmazonSQS Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworksmq_amazonsqs_get($res, 95 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorksMQ_AmazonSQS Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworksmq_amazonsqs_get($res, 96 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorksMQ_AmazonSQS Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworksmq_amazonsqs_get($res, 97 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorksMQ_AmazonSQS Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksmq_amazonsqs_get($res, 98 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorksMQ_AmazonSQS Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworksmq_amazonsqs_get($res, 99 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorksMQ_AmazonSQS Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworksmq_amazonsqs_get($res, 100 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorksMQ_AmazonSQS Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworksmq_amazonsqs_get($res, 101 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorksMQ_AmazonSQS Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworksmq_amazonsqs_get($res, 102 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is 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).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorksMQ_AmazonSQS Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

ipworksmq_amazonsqs_get($res, 103 );

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorksMQ_AmazonSQS Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworksmq_amazonsqs_get($res, 104 );

Default Value

0

Remarks

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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorksMQ_AmazonSQS Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworksmq_amazonsqs_get($res, 105 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksMQ_AmazonSQS Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworksmq_amazonsqs_get($res, 106 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorksMQ_AmazonSQS Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworksmq_amazonsqs_get($res, 107 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorksMQ_AmazonSQS Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworksmq_amazonsqs_get($res, 108 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorksMQ_AmazonSQS Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworksmq_amazonsqs_get($res, 109 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorksMQ_AmazonSQS Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworksmq_amazonsqs_get($res, 110 );

Default Value

0

Remarks

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

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorksMQ_AmazonSQS Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworksmq_amazonsqs_get($res, 111 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorksMQ_AmazonSQS Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworksmq_amazonsqs_get($res, 112 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorksMQ_AmazonSQS Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksmq_amazonsqs_get($res, 113 );

Default Value

''

Remarks

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

StatusLine Property (IPWorksMQ_AmazonSQS Class)

This property is the first line of the last server response.

Object Oriented Interface

public function getStatusLine();

Procedural Interface

ipworksmq_amazonsqs_get($res, 114 );

Default Value

''

Remarks

This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the class, the error string is the same as the StatusLine property.

The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description].

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

Data Type

String

Timeout Property (IPWorksMQ_AmazonSQS Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 115 );
ipworksmq_amazonsqs_set($res, 115, $value );

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.

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

UseSSL Property (IPWorksMQ_AmazonSQS Class)

Use SSL when accessing the service.

Object Oriented Interface

public function getUseSSL();
public function setUseSSL($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 116 );
ipworksmq_amazonsqs_set($res, 116, $value );

Default Value

true

Remarks

Use this property to specify whether the class should use SSL when connecting to the service.

This property is not available at design time.

Data Type

Boolean

VisibilityTimeout Property (IPWorksMQ_AmazonSQS Class)

The visibility duration for messages in the queue.

Object Oriented Interface

public function getVisibilityTimeout();
public function setVisibilityTimeout($value);

Procedural Interface

ipworksmq_amazonsqs_get($res, 117 );
ipworksmq_amazonsqs_set($res, 117, $value );

Default Value

-1

Remarks

Visibility timeout is used to guard against multiple delivery. Successive calls to ListMessages on a queue will not return any message again until the timeout expires, after which the message may reappear unless deleted with DeleteMessage.

A default visibility timeout is configured when a queue is created using CreateQueue, it can also be altered when a message is added using CreateMessage or when they are retrieved using ListMessages.

The default value for VisibilityTimeout is -1, which notifies the component that you would like to use the default behavior for the current Queue.

Note: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their VisibilityTimeout. Attempting to call DeleteMessage for a message received from a FIFO queue after its VisibilityTimeout has expired will cause the server to return an error. Keep this in mind when picking a VisibilityTimeout value to create a FIFO queue and/or retrieve messages with.

Data Type

Integer

AddPermission Method (IPWorksMQ_AmazonSQS Class)

Adds a permission to a queue for a specific account, which allows for sharing access to the queue.

Object Oriented Interface

public function doAddPermission($queueid, $userlabel, $amazonaccount, $permissionname);

Procedural Interface

ipworksmq_amazonsqs_do_addpermission($res, $queueid, $userlabel, $amazonaccount, $permissionname);

Remarks

This method adds a permission to the queue specified by QueueId for the user account specified by AmazonAccount. UserLabel is the unique identification of the permission you're granting, and is used when deleting the permission via the RemovePermission method. The current list of values you may pass in the PermissionName parameter are listed below:

• SendMessage
• ReceiveMessage
• DeleteMessage
• ChangeMessageVisibility
• GetQueueAttributes

Note that when you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue.

AddPermission writes an SQS-generated policy. If you want to write your own policy, use SetQueueAttribute to upload your policy.

This method returns the RequestId contained in the Amazon response.

ChangeMessageVisibility Method (IPWorksMQ_AmazonSQS Class)

Changes the visibility timeout of a message.

Object Oriented Interface

public function doChangeMessageVisibility($queueid, $receipthandle, $visiblitytimeout);

Procedural Interface

ipworksmq_amazonsqs_do_changemessagevisibility($res, $queueid, $receipthandle, $visiblitytimeout);

Remarks

Changes the visibility of the message specified by ReceiptHandle in the queue specified by QueueId. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours.

This method returns the RequestId contained in the Amazon response.

Config Method (IPWorksMQ_AmazonSQS Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksmq_amazonsqs_do_config($res, $configurationstring);

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.

CreateMessage Method (IPWorksMQ_AmazonSQS Class)

Adds a message to a queue.

Object Oriented Interface

public function doCreateMessage($queueid, $message);

Procedural Interface

ipworksmq_amazonsqs_do_createmessage($res, $queueid, $message);

Remarks

Adds a message to the queue specified. If VisibilityTimeout is specified it is updated for all the messages in the queue.

CreateMessage returns a message id assigned to the message that is added to a queue. This can then be used to ListMessages or DeleteMessage.

Note: When adding a message to a FIFO queue, the MessageGroupId configuration setting must be populated before calling this method.

CreateQueue Method (IPWorksMQ_AmazonSQS Class)

Creates an SQS queue.

Object Oriented Interface

public function doCreateQueue($queuename);

Procedural Interface

ipworksmq_amazonsqs_do_createqueue($res, $queuename);

Remarks

A queue with the specified name is created.

CreateQueue returns a queue id assigned to the queue. This can then be used to CreateMessage or DeleteQueue.

If the QueueName ends with .fifo, the queue will be created as a FIFO queue. Alternatively, if the UseFIFOQueues configuration setting is enabled, the class will always attempt to create FIFO queues, appending .fifo to the given QueueName if necessary (all FIFO queues' names must have that suffix).

DeleteMessage Method (IPWorksMQ_AmazonSQS Class)

Deletes the message specified.

Object Oriented Interface

public function doDeleteMessage($queueid, $receipthandle);

Procedural Interface

ipworksmq_amazonsqs_do_deletemessage($res, $queueid, $receipthandle);

Remarks

Deletes the message specified by ReceiptHandle from the queue specified by QueueId.

Note: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their VisibilityTimeout. Attempting to call DeleteMessage for a message received from a FIFO queue after its VisibilityTimeout has expired will cause the server to return an error.

DeleteQueue Method (IPWorksMQ_AmazonSQS Class)

Deletes a queue.

Object Oriented Interface

public function doDeleteQueue($queueid);

Procedural Interface

ipworksmq_amazonsqs_do_deletequeue($res, $queueid);

Remarks

Deletes the queue specified by QueueId.

DoEvents Method (IPWorksMQ_AmazonSQS Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksmq_amazonsqs_do_doevents($res);

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.

GetQueueAttributes Method (IPWorksMQ_AmazonSQS Class)

Returns all attributes of a queue.

Object Oriented Interface

public function doGetQueueAttributes($queueid);

Procedural Interface

ipworksmq_amazonsqs_do_getqueueattributes($res, $queueid);

Remarks

This method retrieves all of the attributes of the queue specified by QueueId, and stores them in the Attributes collection. Queues currently have five attributes that may be returned:

• ApproximateNumberOfMessages
• VisibilityTimeout (for more information, see Visibility Timeout)
• CreatedTimestamp
• LastModifiedTimestamp
• Policy

This method returns the RequestId contained in the Amazon response.

GetXValue Method (IPWorksMQ_AmazonSQS Class)

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

Object Oriented Interface

public function doGetXValue($xpath);

Procedural Interface

ipworksmq_amazonsqs_do_getxvalue($res, $xpath);

Remarks

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

Interrupt Method (IPWorksMQ_AmazonSQS Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksmq_amazonsqs_do_interrupt($res);

Remarks

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

ListMessages Method (IPWorksMQ_AmazonSQS Class)

Gets messages from the queue.

Object Oriented Interface

public function doListMessages($queueid);

Procedural Interface

ipworksmq_amazonsqs_do_listmessages($res, $queueid);

Remarks

This method retrieves messages from the queue specified by QueueId, and fires a Message event for each message it receives. The messages may also be accessed using the property Messages.

If VisibilityTimeout greater than -1 it is applied to the messages, otherwise the default timeout of the queue used. Only one message is retrieved by default; this behavior may be modified by changing MaxMessages.

Note: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their VisibilityTimeout. Attempting to call DeleteMessage for a message received from a FIFO queue after its VisibilityTimeout has expired will cause the server to return an error.

ListQueues Method (IPWorksMQ_AmazonSQS Class)

Lists the queues under the current account.

Object Oriented Interface

public function doListQueues();

Procedural Interface

ipworksmq_amazonsqs_do_listqueues($res);

Remarks

This method will fire a Queue event for each queue available for the Amazon SQS account specified by AccessKey. The listing may be filtered using QueuePrefix.

RemovePermission Method (IPWorksMQ_AmazonSQS Class)

The RemovePermission action revokes any permissions in the queue policy that matches the UserLabel parameter.

Object Oriented Interface

public function doRemovePermission($queueid, $userlabel);

Procedural Interface

ipworksmq_amazonsqs_do_removepermission($res, $queueid, $userlabel);

Remarks

Note that only the owner of the queue may revoke previously added permissions.

This method returns the RequestId contained in the Amazon response.

Reset Method (IPWorksMQ_AmazonSQS Class)

Resets request-related properties.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksmq_amazonsqs_do_reset($res);

Remarks

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

ResetHeaders Method (IPWorksMQ_AmazonSQS Class)

Resets all HTTP headers, cookies, and LocalFile.

Object Oriented Interface

public function doResetHeaders();

Procedural Interface

ipworksmq_amazonsqs_do_resetheaders($res);

Remarks

Resets all the HTTP headers as well as LocalFile to "" (empty string).

Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next one.

SendCustomRequest Method (IPWorksMQ_AmazonSQS Class)

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

Object Oriented Interface

public function doSendCustomRequest($url, $requestdata, $otherheaders);

Procedural Interface

ipworksmq_amazonsqs_do_sendcustomrequest($res, $url, $requestdata, $otherheaders);

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.

SetQueueAttribute Method (IPWorksMQ_AmazonSQS Class)

Sets an attribute of a queue.

Object Oriented Interface

public function doSetQueueAttribute($queueid, $attributename, $attributevalue);

Procedural Interface

ipworksmq_amazonsqs_do_setqueueattribute($res, $queueid, $attributename, $attributevalue);

Remarks

This method sets attributes of the queue specified by QueueId. When you change a queue's attributes, the change can take up to 60 seconds to propagate throughout the SQS system.

This method returns the RequestId contained in the Amazon response.

Connected Event (IPWorksMQ_AmazonSQS Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksmq_amazonsqs_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

Disconnected Event (IPWorksMQ_AmazonSQS Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksmq_amazonsqs_register_callback($res, 2, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (IPWorksMQ_AmazonSQS Class)

Fired when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworksmq_amazonsqs_register_callback($res, 3, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

This event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (IPWorksMQ_AmazonSQS Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksmq_amazonsqs_register_callback($res, 4, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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.

Header Event (IPWorksMQ_AmazonSQS Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

ipworksmq_amazonsqs_register_callback($res, 5, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Message Event (IPWorksMQ_AmazonSQS Class)

Fired for each message retrieved from the queue.

Object Oriented Interface

public function fireMessage($param);

Procedural Interface

ipworksmq_amazonsqs_register_callback($res, 6, array($this, 'fireMessage'));

Parameter List

 'messageid'
 'receipthandle'
 'messagedata'
 'md5'

Remarks

When ListMessages is invoked the class fires Message for each message retrieved. The number of messages retrieved are specified using MaxMessages. OtherData is reserved for future use.

Queue Event (IPWorksMQ_AmazonSQS Class)

Fired for each queue of the user.

Object Oriented Interface

public function fireQueue($param);

Procedural Interface

ipworksmq_amazonsqs_register_callback($res, 7, array($this, 'fireQueue'));

Parameter List

 'queueid'
 'url'

Remarks

When ListQueues is invoked the class fires Queue for each queue.

SSLServerAuthentication Event (IPWorksMQ_AmazonSQS Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksmq_amazonsqs_register_callback($res, 8, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksmq_amazonsqs_register_callback($res, 9, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

StartTransfer Event (IPWorksMQ_AmazonSQS Class)

Fired when a document starts transferring (after the headers).

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksmq_amazonsqs_register_callback($res, 10, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

This event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Status Event (IPWorksMQ_AmazonSQS Class)

Fired when the HTTP status line is received from the server.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

ipworksmq_amazonsqs_register_callback($res, 11, array($this, 'fireStatus'));

Parameter List

 'httpversion'
 'statuscode'
 'description'

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

Transfer Event (IPWorksMQ_AmazonSQS Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksmq_amazonsqs_register_callback($res, 12, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (AmazonSQS Class)

AmazonSQS Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Trappable Errors (AmazonSQS Class)

AmazonSQS 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