Azure Integrator V2 - Online Help
Azure Integrator V2
Questions / Feedback?

Queue Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

InAzure_Queue

Procedural Interface

 inazure_queue_open();
 inazure_queue_close($res);
 inazure_queue_register_callback($res, $id, $function);
 inazure_queue_get_last_error($res);
 inazure_queue_get_last_error_code($res);
 inazure_queue_set($res, $id, $index, $value);
 inazure_queue_get($res, $id, $index);
 inazure_queue_do_addusermetadata($res, $name, $value);
 inazure_queue_do_clearmessages($res);
 inazure_queue_do_config($res, $configurationstring);
 inazure_queue_do_createmessage($res, $messagetext);
 inazure_queue_do_createqueue($res);
 inazure_queue_do_deletemessage($res, $messageid, $popreceipt);
 inazure_queue_do_deletequeue($res);
 inazure_queue_do_doevents($res);
 inazure_queue_do_getqueuemetadata($res);
 inazure_queue_do_interrupt($res);
 inazure_queue_do_listmessages($res);
 inazure_queue_do_listqueues($res);
 inazure_queue_do_peekmessages($res);
 inazure_queue_do_reset($res);
 inazure_queue_do_resetheaders($res);
 inazure_queue_do_setqueuemetadata($res);

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 class 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 class with short descriptions. Click on the links for further details.

AccessKeyThe Windows Azure access key.
AccountThe Windows Azure storage account name.
ApproximateMessageCountThe approximate number of messages in the queue.
ConnectedShows whether the component is connected.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FollowRedirectsDetermines what happens when the server issues a redirect.
IdleThe current status of the component.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessagesCountThe number of records in the Messages arrays.
MessagesDequeueCountWhen ListMessages is called, the message is dequeued and this value is incremented.
MessagesExpirationTimeThe time at which the message will be automatically removed from the queue.
MessagesIdThe Id of the message.
MessagesInsertionTimeThe time at which the message was first inserted into the queue.
MessagesPopReceiptThe pop receipt of the message.
MessagesTextThe message text.
MessagesTimeNextVisibleThe time when the message will be visible to other clients.
MetadataCountThe number of records in the Metadata arrays.
MetadataNameThe name of the current metadata element.
MetadataValueThe value of the current metadata element.
OtherHeadersOther headers as determined by the user (optional).
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
QueueMarkerA string value that identifies the current position in the list of results.
QueueNameThe name of the current queue.
QueuePrefixIf set, ListQueues will only return queues that begin with this prefix.
QueuesCountThe number of records in the Queues arrays.
QueuesNameThe name of the queue.
QueuesURLThe URL of the queue.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
StatusLineThe first line of the last server response.
TimeoutA timeout for the component.
UseSSLUse SSL to access Azure Blob.
VisibilityTimeoutThe visibility duration in seconds for messages in the queue.

Method List


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

AddUserMetadataAdds a name value pair to the metadata to be associated with a queue.
ClearMessagesClears all messages from the queue.
ConfigSets or retrieves a configuration setting .
CreateMessageAdds a message to the queue.
CreateQueueCreates a new queue.
DeleteMessageDeletes the specified message from the queue.
DeleteQueueDeletes the specified queue.
DoEventsProcesses events from the internal message queue.
GetQueueMetadataRetrieves the user defined metadata for a queue.
InterruptInterrupt the current method.
ListMessagesRetrieves message(s) from the current queue.
ListQueuesLists all of the queues in a given storage account.
PeekMessagesRetrieves a message from the front of the queue, without changing the message visibility.
ResetResets request-related properties.
ResetHeadersResets all HTTP headers, cookies, and localfile.
SetQueueMetadataSets user-defined metadata on the queue.

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.

ConnectedFired immediately after a connection completes (or fails).
DisconnectedFired when a connection is closed.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
MessageFired for every message when ListMessages or PeekMessages is called.
MetadataFired for each name value pair in a queue's metadata when GetQueueMetadata or ListQueues is called.
QueueListFired for every queue when ListQueues is called.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TransferFired while a document transfers (delivers document).

Configuration Settings


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

IncludeMetadataSpecifies whether or not the queue's metadata will be returned.
MessageTTLSpecifies the time-to-live interval for the message, in seconds.
MaxResultsSpecifies the maximum number of results to be returned by ListMessages, PeekMessages, or ListQueues.
APIVersionThe API version specified in the request.
TransferredDataReturns the entire XML response received from Azure.
URLIf set, the default URL(http://youraccount.blob.core.windows.net/) will be overridden by this value.
AzureTimeoutGets or sets the service timeout for the request in seconds.
DateFormatThe format string to be used for formatting the DateTime values received from the server.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 2.0.6240.0