Queue Component

Properties Methods Events Configuration Settings Errors

The Queue Component provides an easy to use interface to Microsoft's Windows Azure Queue Service.

Syntax

nsoftware.InAzure.Queue

Remarks

A queue can contain an unlimited number of messages, each of which can be up to 8 KB in size. Messages are generally added to the end of the queue and retrieved from the front of the queue, although first in, first out (FIFO) behavior is not guaranteed.

Please refer to Queue Service Concepts for details.

Before using the component you will first need to sign up for the Azure Storage service and obtain an Account and AccessKey from Microsoft. Then you can start creating Queues in your account using CreateQueue. You can then add messages to any of your queues using CreateMessage.

There are other methods such as ListQueues, ListMessages, PeekMessages, DeleteMessage, DeleteQueue etc. that further enable you to manage your Queue Storage Service.

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 Windows Azure access key.
Account	The Windows Azure storage account name.
ApproximateMessageCount	The approximate number of messages in the queue.
Connected	Shows whether the component is connected.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
Idle	The current status of the component.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Messages	The list of messages returned by a call to ListMessages or PeekMessages .
Metadata	Returns a name-value pair list associated with the queue as metadata.
OtherHeaders	Other headers as determined by the user (optional).
ParsedHeaders	Collection of headers returned from the last request.
Proxy	A set of properties related to proxy access.
QueueMarker	A string value that identifies the current position in the list of results.
QueueName	The name of the current queue.
QueuePrefix	If set, ListQueues will only return queues that begin with this prefix.
Queues	The list of queues returned by a call to ListQueues .
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.
UseSSL	Use SSL to access Azure Blob.
VisibilityTimeout	The visibility duration in seconds 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.


AddUserMetadata	Adds a name value pair to the metadata to be associated with a queue.
ClearMessages	Clears all messages from the queue.
Config	Sets or retrieves a configuration setting .
CreateMessage	Adds a message to the queue.
CreateQueue	Creates a new queue.
DeleteMessage	Deletes the specified message from the queue.
DeleteQueue	Deletes the specified queue.
DoEvents	Processes events from the internal message queue.
GetQueueMetadata	Retrieves the user defined metadata for a queue.
Interrupt	Interrupt the current method.
ListMessages	Retrieves message(s) from the current queue.
ListQueues	Lists all of the queues in a given storage account.
PeekMessages	Retrieves a message from the front of the queue, without changing the message visibility.
Reset	Resets request-related properties.
ResetHeaders	Resets all HTTP headers, cookies, and localfile.
SetQueueMetadata	Sets user-defined metadata on the 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 every message when ListMessages or PeekMessages is called.
Metadata	Fired for each name value pair in a queue's metadata when GetQueueMetadata or ListQueues is called.
QueueList	Fired for every queue when ListQueues is called.
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.


IncludeMetadata	Specifies whether or not the queue's metadata will be returned.
MessageTTL	Specifies the time-to-live interval for the message, in seconds.
MaxResults	Specifies the maximum number of results to be returned by ListMessages, PeekMessages, or ListQueues.
APIVersion	The API version specified in the request.
TransferredData	Returns the entire XML response received from Azure.
URL	If set, the default URL(http://youraccount.blob.core.windows.net/) will be overridden by this value.
AzureTimeout	Gets or sets the service timeout for the request in seconds.
DateFormat	The format string to be used for formatting the DateTime values received from the server.
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.