C# Class Microsoft.WindowsAzure.StorageClient.CloudQueueClient

Provides a client for accessing the Windows Azure Queue service.

Show file Open project: richorama/azure-sdk-for-mono Class Usage Examples

Private Properties

Property	Type	Description
CloudQueueClient	System
CloudQueueClient	System
CloudQueueClient	System
EndGetResponse	System.Net.WebResponse
EndListQueuesSegmented	ResultSegment
GetServicePropertiesImpl	System.Collections.Generic.IEnumerable
ListQueuesImpl	System.Collections.Generic.IEnumerable
ListQueuesImplCore	System.Collections.Generic.IEnumerable
SelectResponse	CloudQueue
SetServicePropertiesImpl	System.Collections.Generic.IEnumerable

Public Methods

Method	Description
BeginGetServiceProperties ( AsyncCallback callback, object state ) : IAsyncResult	Begins an asynchronous operation to get the properties of the queue service.
BeginListQueuesSegmented ( AsyncCallback callback, object state ) : IAsyncResult	Begins an asynchronous operation to return a result segment containing a collection of queues in the storage account.
BeginListQueuesSegmented ( string prefix, AsyncCallback callback, object state ) : IAsyncResult	Begins an asynchronous operation to return a result segment containing a collection of queues whose names begin with the specified prefix.
BeginListQueuesSegmented ( string prefix, QueueListingDetails detailsIncluded, AsyncCallback callback, object state ) : IAsyncResult	Begins an asynchronous operation to return a result segment containing a collection of queues whose names begin with the specified prefix.
BeginListQueuesSegmented ( string prefix, QueueListingDetails detailsIncluded, int maxResults, Microsoft.WindowsAzure.StorageClient.ResultContinuation continuationToken, AsyncCallback callback, object state ) : IAsyncResult	Begins an asynchronous operation to return a result segment containing a collection of queues whose names begin with the specified prefix.
BeginSetServiceProperties ( ServiceProperties properties, AsyncCallback callback, object state ) : IAsyncResult	Begins an asynchronous operation to set the properties of the queue service.
CloudQueueClient ( Uri baseAddressUri, StorageCredentials credentials ) : System	Initializes a new instance of the CloudQueueClient class using the specified Queue service endpoint and account credentials.
CloudQueueClient ( string baseAddress, StorageCredentials credentials ) : System	Initializes a new instance of the CloudQueueClient class using the specified Queue service endpoint and account credentials.
EndGetServiceProperties ( IAsyncResult asyncResult ) : ServiceProperties	Ends an asynchronous operation to get the properties of the queue service.
EndSetServiceProperties ( IAsyncResult asyncResult ) : void	Ends an asynchronous operation to set the properties of the queue service.
GetQueueReference ( string queueAddress ) : CloudQueue	Gets a reference to the queue at the specified address.
GetServiceProperties ( ) : ServiceProperties	Gets the properties of the queue service.
ListQueues ( ) : IEnumerable	Returns an enumerable collection of the queues in the storage account.
ListQueues ( string prefix ) : IEnumerable	Returns an enumerable collection of the queues in the storage account whose names begin with the specified prefix.
ListQueues ( string prefix, QueueListingDetails detailsIncluded ) : IEnumerable	Returns an enumerable collection of the queues in the storage account whose names begin with the specified prefix and that are retrieved lazily.
ListQueuesSegmented ( ) : ResultSegment	Returns a result segment containing a collection of queues in the storage account.
ListQueuesSegmented ( string prefix, QueueListingDetails detailsIncluded ) : ResultSegment	Returns a result segment containing a collection of queues in the storage account.
ListQueuesSegmented ( string prefix, QueueListingDetails detailsIncluded, int maxResults, ResultContinuation continuationToken ) : ResultSegment	Returns a result segment containing a collection of queues whose names begin with the specified prefix.
SetServiceProperties ( ServiceProperties properties ) : void	Sets the properties of the queue service.

Private Methods

Method	Description
CloudQueueClient ( Uri baseAddressUri, StorageCredentials credentials, bool usePathStyleUris ) : System	Initializes a new instance of the CloudQueueClient class.
CloudQueueClient ( bool usePathStyleUris, Uri baseAddressUri, StorageCredentials credentials ) : System	Initializes a new instance of the CloudQueueClient class.
CloudQueueClient ( string baseAddress, StorageCredentials credentials, bool usePathStyleUris ) : System	Initializes a new instance of the CloudQueueClient class.
EndGetResponse ( IAsyncResult asyncresult, WebRequest req ) : WebResponse	Ends the get response.
EndListQueuesSegmented ( IAsyncResult asyncResult ) : ResultSegment
GetServicePropertiesImpl ( Action setResult ) : System.Collections.Generic.IEnumerable	Generates a task sequence for getting the properties of the queue service.
ListQueuesImpl ( string prefix, QueueListingDetails detailsIncluded, Microsoft.WindowsAzure.StorageClient.ResultContinuation continuationToken, int maxResults, Action setResult ) : System.Collections.Generic.IEnumerable	Lists the queues impl.
ListQueuesImplCore ( string prefix, QueueListingDetails detailsIncluded, Microsoft.WindowsAzure.StorageClient.ResultContinuation continuationToken, Microsoft.WindowsAzure.StorageClient.ResultPagination pagination, Action setResult ) : System.Collections.Generic.IEnumerable	Lists the queues impl core.
SelectResponse ( QueueEntry item ) : CloudQueue	Selects the response.
SetServicePropertiesImpl ( ServiceProperties properties ) : System.Collections.Generic.IEnumerable	Generates a task sequence for setting the properties of the queue service.

Method Details

BeginGetServiceProperties() public method

Begins an asynchronous operation to get the properties of the queue service.

public BeginGetServiceProperties ( AsyncCallback callback, object state ) : IAsyncResult
callback	AsyncCallback	The callback delegate that will receive notification when the asynchronous operation completes.
state	object	A user defined object to be passed to the callback delegate.
return	IAsyncResult

BeginListQueuesSegmented() public method

Begins an asynchronous operation to return a result segment containing a collection of queues in the storage account.

public BeginListQueuesSegmented ( AsyncCallback callback, object state ) : IAsyncResult
callback	AsyncCallback	The callback delegate that will receive notification when the asynchronous operation completes.
state	object	A user-defined object that will be passed to the callback delegate.
return	IAsyncResult

BeginListQueuesSegmented() public method

Begins an asynchronous operation to return a result segment containing a collection of queues whose names begin with the specified prefix.

public BeginListQueuesSegmented ( string prefix, AsyncCallback callback, object state ) : IAsyncResult
prefix	string	The queue name prefix.
callback	AsyncCallback	The callback delegate that will receive notification when the asynchronous operation completes.
state	object	A user-defined object that will be passed to the callback delegate.
return	IAsyncResult

BeginListQueuesSegmented() public method

Begins an asynchronous operation to return a result segment containing a collection of queues whose names begin with the specified prefix.

public BeginListQueuesSegmented ( string prefix, QueueListingDetails detailsIncluded, AsyncCallback callback, object state ) : IAsyncResult
prefix	string	The queue name prefix.
detailsIncluded	QueueListingDetails	One of the enumeration values that indicates which details to include in the listing.
callback	AsyncCallback	The callback delegate that will receive notification when the asynchronous operation completes.
state	object	A user-defined object that will be passed to the callback delegate.
return	IAsyncResult

BeginListQueuesSegmented() public method

Begins an asynchronous operation to return a result segment containing a collection of queues whose names begin with the specified prefix.

public BeginListQueuesSegmented ( string prefix, QueueListingDetails detailsIncluded, int maxResults, Microsoft.WindowsAzure.StorageClient.ResultContinuation continuationToken, AsyncCallback callback, object state ) : IAsyncResult
prefix	string	The queue name prefix.
detailsIncluded	QueueListingDetails	One of the enumeration values that indicates which details to include in the listing.
maxResults	int	A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the /// per-operation limit of 5000. If this value is zero, the maximum possible number of results will be returned, up to 5000.
continuationToken	Microsoft.WindowsAzure.StorageClient.ResultContinuation	A continuation token returned by a previous listing operation.
callback	AsyncCallback	The callback delegate that will receive notification when the asynchronous operation completes.
state	object	A user-defined object that will be passed to the callback delegate.
return	IAsyncResult

BeginSetServiceProperties() public method

Begins an asynchronous operation to set the properties of the queue service.

public BeginSetServiceProperties ( ServiceProperties properties, AsyncCallback callback, object state ) : IAsyncResult
properties	ServiceProperties	The queue service properties.
callback	AsyncCallback	The callback delegate that will receive notification when the asynchronous operation completes.
state	object	A user defined object to be passed to the callback delegate.
return	IAsyncResult

CloudQueueClient() public method

Initializes a new instance of the CloudQueueClient class using the specified Queue service endpoint and account credentials.

public CloudQueueClient ( Uri baseAddressUri, StorageCredentials credentials ) : System
baseAddressUri	System.Uri	The Queue service endpoint to use to create the client.
credentials	StorageCredentials	The account credentials.
return	System

CloudQueueClient() public method

Initializes a new instance of the CloudQueueClient class using the specified Queue service endpoint and account credentials.

public CloudQueueClient ( string baseAddress, StorageCredentials credentials ) : System
baseAddress	string	The Queue service endpoint to use to create the client.
credentials	StorageCredentials	The account credentials.
return	System

EndGetServiceProperties() public method

Ends an asynchronous operation to get the properties of the queue service.

public EndGetServiceProperties ( IAsyncResult asyncResult ) : ServiceProperties
asyncResult	IAsyncResult	The result returned from a prior call to .
return	ServiceProperties

EndSetServiceProperties() public method

Ends an asynchronous operation to set the properties of the queue service.

public EndSetServiceProperties ( IAsyncResult asyncResult ) : void
asyncResult	IAsyncResult	The result returned from a prior call to .
return	void

GetQueueReference() public method

Gets a reference to the queue at the specified address.

public GetQueueReference ( string queueAddress ) : CloudQueue
queueAddress	string	Either the name of the queue, or the absolute URI to the queue.
return	CloudQueue

GetServiceProperties() public method

Gets the properties of the queue service.

public GetServiceProperties ( ) : ServiceProperties
return	ServiceProperties

ListQueues() public method

Returns an enumerable collection of the queues in the storage account.

public ListQueues ( ) : IEnumerable
return	IEnumerable

ListQueues() public method

Returns an enumerable collection of the queues in the storage account whose names begin with the specified prefix.

public ListQueues ( string prefix ) : IEnumerable
prefix	string	The queue name prefix.
return	IEnumerable

ListQueues() public method

Returns an enumerable collection of the queues in the storage account whose names begin with the specified prefix and that are retrieved lazily.

public ListQueues ( string prefix, QueueListingDetails detailsIncluded ) : IEnumerable
prefix	string	The queue name prefix.
detailsIncluded	QueueListingDetails	One of the enumeration values that indicates which details to include in the listing.
return	IEnumerable

ListQueuesSegmented() public method

Returns a result segment containing a collection of queues in the storage account.

public ListQueuesSegmented ( ) : ResultSegment
return	ResultSegment

ListQueuesSegmented() public method

Returns a result segment containing a collection of queues in the storage account.

public ListQueuesSegmented ( string prefix, QueueListingDetails detailsIncluded ) : ResultSegment
prefix	string	The queue name prefix.
detailsIncluded	QueueListingDetails	One of the enumeration values that indicates which details to include in the listing.
return	ResultSegment

ListQueuesSegmented() public method

Returns a result segment containing a collection of queues whose names begin with the specified prefix.

public ListQueuesSegmented ( string prefix, QueueListingDetails detailsIncluded, int maxResults, ResultContinuation continuationToken ) : ResultSegment
prefix	string	The queue name prefix.
detailsIncluded	QueueListingDetails	One of the enumeration values that indicates which details to include in the listing.
maxResults	int	A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the /// per-operation limit of 5000. If this value is zero, the maximum possible number of results will be returned, up to 5000.
continuationToken	ResultContinuation	A continuation token returned by a previous listing operation.
return	ResultSegment

SetServiceProperties() public method

Sets the properties of the queue service.

public SetServiceProperties ( ServiceProperties properties ) : void
properties	ServiceProperties	The queue service properties.
return	void