Click or drag to resize
IQueueingServiceListQueuesAsync Method
This API is preliminary and subject to change.
Gets a list of queues.

Namespace: net.openstack.Core.Providers
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax
Task<ReadOnlyCollectionPage<CloudQueue>> ListQueuesAsync(
	QueueName marker,
	Nullable<int> limit,
	bool detailed,
	CancellationToken cancellationToken
)

Parameters

marker
Type: net.openstack.Core.Domain.QueuesQueueName
The name of the last queue in the previous list. The resulting collection of queues will start with the first queue after this value, when sorted using Ordinal. If this value is , the list starts at the beginning.
limit
Type: SystemNullableInt32
The maximum number of queues to return. If this value is , a provider-specific default value is used.
detailed
Type: SystemBoolean
to return detailed information about each queue; otherwise, .
cancellationToken
Type: System.ThreadingCancellationToken
The CancellationToken that the task will observe.

Return Value

Type: TaskReadOnlyCollectionPageCloudQueue
A Task object representing the asynchronous operation. When the task completes successfully, the Result property will contain placeholder.
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionIf limit is less than or equal to 0.
WebExceptionIf the REST request does not return successfully.
Examples

The following example demonstrates the use of this method using the CloudQueuesProvider implementation of the IQueueingService. For more information about creating the provider, see CloudQueuesProvider(CloudIdentity, String, Guid, Boolean, IIdentityProvider).

Note Note

The following code uses the / operators. For more information about using these operators in your code, see Asynchronous Services.

IQueueingService queueingService = new CloudQueuesProvider(identity, region, clientId, internalUrl, identityProvider);
ReadOnlyCollectionPage<CloudQueue> queuesPage = await queueingService.ListQueuesAsync(null, null, true, CancellationToken.None);
ReadOnlyCollection<CloudQueue> queues = await queuesPage.GetAllPagesAsync(CancellationToken.None, null);

The following code shows demonstrates the same example using the Task Parallel Library instead of the / operators.

IQueueingService queueingService = new CloudQueuesProvider(identity, region, clientId, internalUrl, identityProvider);
Task<ReadOnlyCollectionPage<CloudQueue>> queuesPageTask = queueingService.ListQueuesAsync(null, null, true, CancellationToken.None);
Task<ReadOnlyCollection<CloudQueue>> queuesTask =
    queuesPageTask
    .ContinueWith(task => task.Result.GetAllPagesAsync(CancellationToken.None, null))
    .Unwrap();
Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also