AzureRequest Class
Properties Methods Events Configuration Settings Errors
The AzureRequest Component provides a generic interface to Microsoft's Windows Azure Service.
Class Name
InAzure_AzureRequest
Procedural Interface
inazure_azurerequest_open(); inazure_azurerequest_close($res); inazure_azurerequest_register_callback($res, $id, $function); inazure_azurerequest_get_last_error($res); inazure_azurerequest_get_last_error_code($res); inazure_azurerequest_set($res, $id, $index, $value); inazure_azurerequest_get($res, $id, $index); inazure_azurerequest_do_addparameter($res, $paramname, $paramvalue); inazure_azurerequest_do_attr($res, $attrname); inazure_azurerequest_do_config($res, $configurationstring); inazure_azurerequest_do_doevents($res); inazure_azurerequest_do_get($res, $url); inazure_azurerequest_do_interrupt($res); inazure_azurerequest_do_reset($res); inazure_azurerequest_do_submitto($res, $url);
Remarks
AzureRequest provides a generic interface for creating globally accessible cloud computing interfaces on Windows Azure Storage. Please refer to Windows Azure Storage for further details.
Before using the class you will first need to sign up for the Windows Azure Storage service and obtain an Account and AccessKey from Windows Azure.
After obtaining an Account and Access Key, you will be able to interact with the Blob, Table and Queue Storage services.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| AccessKey | The Windows Azure access key. |
| Account | The Windows Azure storage account name. |
| APIVersion | Version of the API you're using to submit a transaction. |
| BuildDOM | When True, an internal object model of the XML document is created. |
| Connected | Shows whether the component is connected. |
| ContentType | Content type for posts and puts. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| HTTPMethod | The HTTP method used for the request. |
| Idle | The current status of the component. |
| LocalFile | The path to a local file for downloading. If the file exists, it is overwritten. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| NamespaceCount | The number of records in the Namespace arrays. |
| NamespacePrefix | The Prefix for the Namespace . |
| NamespaceURI | Namespace URI associated with the corresponding Prefix . |
| OtherHeaders | Other headers as determined by the user (optional). |
| ParameterCount | The number of records in the Parameter arrays. |
| ParameterName | The Name of the Azure Parameter. |
| ParameterValue | The Value of the Azure Parameter. |
| ParsedHeaderCount | The number of records in the ParsedHeader arrays. |
| ParsedHeaderField | This property contains the name of the HTTP header (same case as it is delivered). |
| ParsedHeaderValue | This property contains the header contents. |
| PostData | The data to post with the URL if the POST method is used. |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use SSL for the connection to the proxy. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If 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. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| StatusLine | The first line of the last server response. |
| StoreType | The type of store the for which the request is being built. |
| Timeout | A timeout for the component. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum of bytes of data to be transferred. |
| TransferredHeaders | The full set of headers as received from the server. |
| Validate | When True, the parser checks that the document consists of well-formed XML. |
| AttrCount | The number of records in the Attr arrays. |
| AttrName | The Name provides the local name (without prefix) of the attribute. |
| AttrNamespace | Attribute namespace. |
| AttrPrefix | Attribute prefix (if any). |
| AttrValue | Attribute value. |
| XChildrenCount | The number of records in the XChild arrays. |
| XChildName | The Name property provides the local name (without prefix) of the element. |
| XChildNamespace | Namespace of the element. |
| XChildPrefix | Prefix of the element (if any). |
| XChildXText | The inner text of the element. |
| XElement | The name of the current element. |
| XErrorPath | An XPath to check the server response for errors. |
| XNamespace | The namespace of the current element. |
| XParent | The parent of the current element. |
| XPath | Provides a way to point to a specific element in the response. |
| XPrefix | The prefix of the current element. |
| XSubTree | A snapshot of the current element in the document. |
| XText | The text of the current element. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| AddParameter | Adds a parameter to the query string. |
| Attr | Returns the value of the specified attribute. |
| Config | Sets or retrieves a configuration setting . |
| DoEvents | Processes events from the internal message queue. |
| Get | Fetches the document using the HTTP GET method. |
| Interrupt | Interrupt the current method. |
| Reset | Resets the component. |
| SubmitTo | Post current parameters to the URL specified by the 'URL' parameter. |
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.
| Characters | Fired for plain text segments of the input stream. |
| Comment | Fired when a comment section is encountered. |
| Connected | Fired immediately after a connection completes (or fails). |
| ConnectionStatus | Fired to indicate changes in connection state. |
| Disconnected | Fired when a connection is closed. |
| EndElement | Fired when an end-element tag is encountered. |
| EndPrefixMapping | Fired when leaving the scope of a namespace declaration. |
| Error | Information about errors during data delivery. |
| EvalEntity | Fired every time an entity needs to be evaluated. |
| Header | Fired every time a header line comes in. |
| IgnorableWhitespace | Fired when a section of ignorable whitespace is encountered. |
| Meta | Fired when a meta section is encountered. |
| PI | Fired when a processing instruction section is encountered. |
| Redirect | Fired when a redirection is received from the server. |
| SpecialSection | Fired when a special section is encountered. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
| StartElement | Fired when a begin-element tag is encountered in the document. |
| StartPrefixMapping | Fired when entering the scope of a namespace declaration. |
| Status | Fired when the HTTP status line is received from the server. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| CacheContent | If true, the original XML is saved in a buffer. |
| ErrorCodePath | The path to the error code in the response. |
| ErrorMessagePath | The path to the error message in the response. |
| 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. |
| From | Allows the specification of the email address of the HTTP agent. |
| CacheContent | If true, the original XML is saved in a buffer. |
| 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. |