Search: 
Available in: AMAZON
SQS Component [IBiz Amazon Integrator V2]

Properties   Methods   Events   Configuration Settings  

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

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 loosing messages or requiring each component to be always available. A brief synopsis follows but please refer to http://aws.amazon.com/sqs 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 complete descriptions.

AccessKey The Access Key Id for the Amazon Web Services account.
DeleteAfterGet Optionally deletes a message immediately after it is retrieved.
FirewallHost Name or IP address of firewall (optional).
FirewallPassword A password if authentication is to be used when connecting through the firewall.
FirewallPort Port of the firewall to connect to.
FirewallType Determines the type of firewall to connect through.
FirewallUser A user name if authentication is to be used connecting through a firewall.
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.
OtherHeaders Other headers as determined by the user (optional).
ProxyAuthorization Similar to the Authorization property, but for proxy authorization.
ProxyPassword A password if Basic 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 Basic authentication is to be used for the proxy.
QueuePrefix QueuePrefix can be used to filter the queues listed.
Referer Referer URL/document (optional).
SecretKey The Secret Access Key for the Amazon Web Services account.
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 complete descriptions.

Config Sets or retrieves a component configuration setting.
CreateMessage Adds a message to a queue.
CreateQueue Creates an SQS queue.
DeleteMessage Deletes the message specified.
DeleteQueue Deletes a queue.
ListMessages Gets messages from the queue.
ListQueues Lists the queues under the current account.
ResetHeaders Resets all HTTP headers, cookies, and LocalFile.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

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.
MessageList Fired for each message retrieved from the queue.
QueueList 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 complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
HTTPVersion The version of HTTP used by the component
IfModifiedSince A date determining the maximum age of the desired document.
InBufferSize The size in bytes of the incoming queue of the socket.
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData The maximum number of incoming bytes to be stored by the component.
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).
OutBufferSize The size in bytes of the outgoing queue of the socket.
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyPassword A password if Basic 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 Basic authentication is to be used for the proxy.
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
SocketHandle The handle of the main socket used by the component.
UseWinInet If set, the WinInet API is used for retrieving the URL
UseWinInetCookies Controls whether to send and accept cookies when making http requests through WinInet
UserAgent Information about the user agent (browser).
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.