SQS Component
Properties Methods Events Configuration Settings Errors
The SQS Component provides an easy interface to Amazon's Simple Queue Service (SQS).
Syntax
nsoftware.InAmazon.Sqs
Remarks
The SQS Component 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.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| AccessKey | The Access Key Id for the Amazon Web Services account. |
| Attributes | A list of attributes for a queue. |
| Firewall | A set of properties related to firewall access. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| MaxMessages | The maximum number of messages retrieved from the queue. |
| Messages | The messages retrieved as a result of calling ListMessages . |
| OtherHeaders | Other headers as determined by the user (optional). |
| Proxy | A set of properties related to proxy access. |
| QueuePrefix | QueuePrefix can be used to filter the queues listed. |
| Queues | The queues retrieved as a result of calling ListMessages . |
| Referer | Referer URL/document (optional). |
| SecretKey | The Secret Access Key for the Amazon Web Services account. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
| StatusLine | The first line of the last server response. |
| Timeout | A timeout for the component. |
| VisibilityTimeout | The visibility duration for messages in the queue. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| AddPermission | Adds a permission to a queue for a specific account, which allows for sharing access to the queue. |
| ChangeMessageVisibility | Changes the visibility timeout of a message. |
| Config | Sets or retrieves a configuration setting . |
| CreateMessage | Adds a message to a queue. |
| CreateQueue | Creates an SQS queue. |
| DeleteMessage | Deletes the message specified. |
| DeleteQueue | Deletes a queue. |
| DoEvents | Processes events from the internal message queue. |
| GetQueueAttributes | Returns all attributes of a queue. |
| GetXValue | Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest . |
| Interrupt | Interrupt the current method. |
| ListMessages | Gets messages from the queue. |
| ListQueues | Lists the queues under the current account. |
| RemovePermission | The RemovePermission action revokes any permissions in the queue policy that matches the UserLabel parameter. |
| Reset | Resets request-related properties. |
| ResetHeaders | Resets all HTTP headers, cookies, and localfile. |
| SendCustomRequest | Allows the sending of a custom request to an Amazon web service. |
| SetQueueAttribute | Sets an attribute of a queue. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Connected | Fired immediately after a connection completes (or fails). |
| Disconnected | Fired when a connection is closed. |
| EndTransfer | Fired when a document finishes transferring. |
| Error | Information about errors during data delivery. |
| Header | Fired every time a header line comes in. |
| Message | Fired for each message retrieved from the queue. |
| Queue | Fired for each queue of the user. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
| StartTransfer | Fired when a document starts transferring (after the headers). |
| Status | Fired when the HTTP status line is received from the server. |
| Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| MessageGroupId | The ID of the message group to which the message belongs. |
| PurgeQueue | Deletes all messages in a queue specified by the QueueId. |
| APIVersion | Amazon's API version. |
| HTTPMethod | Specifies the HTTP method to use when sending a custom request. |
| SignCustomRequest | Tells the component to sign the outgoing request. |
| TransferredData | Returns the entire XML response received from Amazon. |
| URL | If set, the default URL will be overridden by this value. |
| MessageAttributeCount | The number of message attributes. |
| MessageAttributeName[i] | The name of the message attribute. |
| MessageAttributeDataType[i] | The data type of the message attribute. |
| MessageAttributeValue[i] | The value of the message attribute. |
| SignatureVersion | The version of signature used. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |