azure::storage::cloud_queue Class Reference

Represents a queue in the Windows Azure Queue service. More...

Public Member Functions
	cloud_queue ()
	Initializes a new instance of the azure::storage::cloud_queue class. More...
WASTORAGE_API	cloud_queue (const storage_uri &uri)
	Initializes a new instance of the azure::storage::cloud_queue class. More...
WASTORAGE_API	cloud_queue (const storage_uri &uri, storage_credentials credentials)
	Initializes a new instance of the azure::storage::cloud_queue class. More...
void	create ()
	Creates the queue. More...
void	create (const queue_request_options &options, operation_context context)
	Creates the queue. More...
pplx::task< void >	create_async ()
	Intitiates an asynchronous operation to create the queue. More...
WASTORAGE_API pplx::task< void >	create_async (const queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation to create the queue. More...
bool	create_if_not_exists ()
	Creates the queue if it does not already exist. More...
bool	create_if_not_exists (const queue_request_options &options, operation_context context)
	Creates the queue if it does not already exist. More...
pplx::task< bool >	create_if_not_exists_async ()
	Intitiates an asynchronous operation to create the queue if it does not already exist. More...
WASTORAGE_API pplx::task< bool >	create_if_not_exists_async (const queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation to create the queue if it does not already exist. More...
void	delete_queue ()
	Deletes the queue. More...
void	delete_queue (const queue_request_options &options, operation_context context)
	Deletes the queue. More...
pplx::task< void >	delete_queue_async ()
	Intitiates an asynchronous operation to delete the queue. More...
WASTORAGE_API pplx::task< void >	delete_queue_async (const queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation to delete the queue. More...
bool	delete_queue_if_exists ()
	Deletes the queue if it exists. More...
bool	delete_queue_if_exists (const queue_request_options &options, operation_context context)
	Deletes the queue if it exists. More...
pplx::task< bool >	delete_queue_if_exists_async ()
	Intitiates an asynchronous operation to delete the queue if it exists. More...
WASTORAGE_API pplx::task< bool >	delete_queue_if_exists_async (const queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation to delete the queue if it exists. More...
bool	exists () const
	Checks for the existence of the queue. More...
bool	exists (const queue_request_options &options, operation_context context) const
	Checks for the existence of the queue. More...
pplx::task< bool >	exists_async () const
	Intitiates an asynchronous operation to check for the existence of the queue. More...
WASTORAGE_API pplx::task< bool >	exists_async (const queue_request_options &options, operation_context context) const
	Intitiates an asynchronous operation to check for the existence of the queue. More...
void	add_message (cloud_queue_message &message)
	Adds a message to the queue. More...
void	add_message (cloud_queue_message &message, std::chrono::seconds time_to_live, std::chrono::seconds initial_visibility_timeout, queue_request_options &options, operation_context context)
	Adds a message to the queue. More...
pplx::task< void >	add_message_async (cloud_queue_message &message)
	Intitiates an asynchronous operation to add a message to the queue. More...
WASTORAGE_API pplx::task< void >	add_message_async (cloud_queue_message &message, std::chrono::seconds time_to_live, std::chrono::seconds initial_visibility_timeout, queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation to add a message to the queue. More...
cloud_queue_message	get_message ()
	Retrieves a message from the front of the queue More...
cloud_queue_message	get_message (std::chrono::seconds visibility_timeout, queue_request_options &options, operation_context context)
	Retrieves a message from the front of the queue More...
pplx::task< cloud_queue_message >	get_message_async ()
	Intitiates an asynchronous operation that retrieves a message from the front of the queue More...
WASTORAGE_API pplx::task< cloud_queue_message >	get_message_async (std::chrono::seconds visibility_timeout, queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation that retrieves a message from the front of the queue More...
std::vector< cloud_queue_message >	get_messages (size_t message_count)
	Retrieves the specified number of messages from the front of the queue. More...
std::vector< cloud_queue_message >	get_messages (size_t message_count, std::chrono::seconds visibility_timeout, queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation that retrieves the specified number of messages from the front of the queue. More...
pplx::task< std::vector< cloud_queue_message > >	get_messages_async (size_t message_count)
	Intitiates an asynchronous operation that retrieves the specified number of messages from the front of the queue. More...
WASTORAGE_API pplx::task< std::vector< cloud_queue_message > >	get_messages_async (size_t message_count, std::chrono::seconds visibility_timeout, queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation that retrieves the specified number of messages from the front of the queue. More...
cloud_queue_message	peek_message () const
	Peeks a message from the front of the queue More...
cloud_queue_message	peek_message (const queue_request_options &options, operation_context context) const
	Peeks a message from the front of the queue More...
pplx::task< cloud_queue_message >	peek_message_async () const
	Intitiates an asynchronous operation that peeks a message from the front of the queue More...
WASTORAGE_API pplx::task< cloud_queue_message >	peek_message_async (const queue_request_options &options, operation_context context) const
	Intitiates an asynchronous operation that peeks a message from the front of the queue More...
std::vector< cloud_queue_message >	peek_messages (size_t message_count) const
	Retrieves the specified number of messages from the front of the queue, without affecting message visibility. More...
std::vector< cloud_queue_message >	peek_messages (size_t message_count, const queue_request_options &options, operation_context context) const
	Retrieves the specified number of messages from the front of the queue, without affecting message visibility. More...
pplx::task< std::vector< cloud_queue_message > >	peek_messages_async (size_t message_count) const
	Intitiates an asynchronous operation that retrieves the specified number of messages from the front of the queue, without affecting message visibility. More...
WASTORAGE_API pplx::task< std::vector< cloud_queue_message > >	peek_messages_async (size_t message_count, const queue_request_options &options, operation_context context) const
	Intitiates an asynchronous operation that retrieves the specified number of messages from the front of the queue, without affecting message visibility. More...
void	update_message (cloud_queue_message &message, std::chrono::seconds visibility_timeout, bool update_content)
	Updates the visibility timeout and the contents of the specified message in the queue. More...
void	update_message (cloud_queue_message &message, std::chrono::seconds visibility_timeout, bool update_content, queue_request_options &options, operation_context context)
	Updates the visibility timeout and the contents of the specified message in the queue. More...
pplx::task< void >	update_message_async (cloud_queue_message &message, std::chrono::seconds visibility_timeout, bool update_content)
	Intitiates an asynchronous operation that updates the visibility timeout and the contents of the specified message in the queue. More...
WASTORAGE_API pplx::task< void >	update_message_async (cloud_queue_message &message, std::chrono::seconds visibility_timeout, bool update_content, queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation that updates the visibility timeout and the contents of the specified message in the queue. More...
void	delete_message (cloud_queue_message &message)
	Deletes the given message from the queue. More...
void	delete_message (cloud_queue_message &message, queue_request_options &options, operation_context context)
	Deletes the given message from the queue. More...
pplx::task< void >	delete_message_async (cloud_queue_message &message)
	Intitiates an asynchronous operation that deletes the given message from the queue. More...
WASTORAGE_API pplx::task< void >	delete_message_async (cloud_queue_message &message, queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation that deletes the given message from the queue. More...
void	clear ()
	Deletes all the messages in the queue. More...
void	clear (const queue_request_options &options, operation_context context)
	Deletes all the messages in the queue. More...
pplx::task< void >	clear_async ()
	Intitiates an asynchronous operation that deletes all the messages in the queue. More...
WASTORAGE_API pplx::task< void >	clear_async (const queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation that deletes all the messages in the queue. More...
void	download_attributes ()
	Retrieves the user-defined metadata for the queue. More...
void	download_attributes (const queue_request_options &options, operation_context context)
	Retrieves the user-defined metadata for the queue. More...
pplx::task< void >	download_attributes_async ()
	Intitiates an asynchronous operation that retrieves the user-defined metadata for the queue. More...
WASTORAGE_API pplx::task< void >	download_attributes_async (const queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation that retrieves the user-defined metadata for the queue. More...
void	upload_metadata ()
	Sets the user-defined metadata for the queue. More...
void	upload_metadata (const queue_request_options &options, operation_context context)
	Sets the user-defined metadata for the queue. More...
pplx::task< void >	upload_metadata_async ()
	Intitiates an asynchronous operation that sets the user-defined metadata for the queue. More...
WASTORAGE_API pplx::task< void >	upload_metadata_async (const queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation that sets the user-defined metadata for the queue. More...
queue_permissions	download_permissions () const
	Retrieves the shared access policies for the queue. More...
queue_permissions	download_permissions (const queue_request_options &options, operation_context context) const
	Retrieves the shared access policies for the queue. More...
pplx::task< queue_permissions >	download_permissions_async () const
	Intitiates an asynchronous operation that retrieves the shared access policies for the queue. More...
WASTORAGE_API pplx::task< queue_permissions >	download_permissions_async (const queue_request_options &options, operation_context context) const
	Intitiates an asynchronous operation that retrieves the shared access policies for the queue. More...
void	upload_permissions (const queue_permissions &permissions)
	Sets permissions for the queue. More...
void	upload_permissions (const queue_permissions &permissions, const queue_request_options &options, operation_context context)
	Sets permissions for the queue. More...
pplx::task< void >	upload_permissions_async (const queue_permissions &permissions)
	Intitiates an asynchronous operation that sets permissions for the queue. More...
WASTORAGE_API pplx::task< void >	upload_permissions_async (const queue_permissions &permissions, const queue_request_options &options, operation_context context)
	Intitiates an asynchronous operation that sets permissions for the queue. More...
utility::string_t	get_shared_access_signature (const queue_shared_access_policy &policy) const
	Gets a shared access signature for the queue. More...
WASTORAGE_API utility::string_t	get_shared_access_signature (const queue_shared_access_policy &policy, const utility::string_t &stored_policy_identifier) const
	Gets a shared access signature for the queue. More...
const cloud_queue_client &	service_client () const
	Gets the Queue service client that specifies the endpoint for the queue service. More...
const utility::string_t &	name () const
	Gets the name of the queue. More...
const storage_uri &	uri () const
	Gets the queue URI for all locations. More...
int	approximate_message_count () const
	Gets the approximate number of messages in the queue or -1 if unknown. More...
cloud_metadata &	metadata ()
	Gets an unordered map containing user-defined key/value pairs associated with the queue. More...
const cloud_metadata &	metadata () const
	Gets an unordered map containing user-defined key/value pairs associated with the queue. More...
void	set_metadata (cloud_metadata value)
	Sets an unordered map containing user-defined key/value pairs associated with the queue. More...
const storage_uri &	queue_message_uri () const
	Return the storage uri for queue message's operations. More...

Detailed Description

Represents a queue in the Windows Azure Queue service.

Constructor & Destructor Documentation

cloud_queue() [1/3]

azure::storage::cloud_queue::cloud_queue ( )

inline

Initializes a new instance of the azure::storage::cloud_queue class.

cloud_queue() [2/3]

WASTORAGE_API azure::storage::cloud_queue::cloud_queue

(

const storage_uri &

uri

)

Initializes a new instance of the azure::storage::cloud_queue class.

Parameters

uri	An azure::storage::storage_uri object containing the absolute URI to the queue for all locations.

cloud_queue() [3/3]

WASTORAGE_API azure::storage::cloud_queue::cloud_queue	(	const storage_uri &	uri,
		storage_credentials	credentials
	)

Initializes a new instance of the azure::storage::cloud_queue class.

Parameters

uri	An azure::storage::storage_uri object containing the absolute URI to the queue for all locations.
credentials	The azure::storage::storage_credentials to use.

Member Function Documentation

add_message() [1/2]

void azure::storage::cloud_queue::add_message ( cloud_queue_message &  message )

inline

Adds a message to the queue.

Parameters

message

The message to add to the queue.

add_message() [2/2]

void azure::storage::cloud_queue::add_message ( cloud_queue_message &  message, std::chrono::seconds  time_to_live, std::chrono::seconds  initial_visibility_timeout, queue_request_options &  options, operation_context  context  )

inline

Adds a message to the queue.

Parameters

message	The message to add to the queue.
time_to_live	The maximum time to allow the message to be in the queue.
initial_visibility_timeout	The length of time from now during which the message will be invisible.
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

add_message_async() [1/2]

pplx::task<void> azure::storage::cloud_queue::add_message_async ( cloud_queue_message &  message )

inline

Intitiates an asynchronous operation to add a message to the queue.

Parameters

message

The message to add to the queue.

Returns

A pplx::task object that represents the current operation.

add_message_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_queue::add_message_async	(	cloud_queue_message &	message,
		std::chrono::seconds	time_to_live,
		std::chrono::seconds	initial_visibility_timeout,
		queue_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to add a message to the queue.

Parameters

message	The message to add to the queue.
time_to_live	The maximum time to allow the message to be in the queue.
initial_visibility_timeout	The length of time from now during which the message will be invisible.
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.

approximate_message_count()

int azure::storage::cloud_queue::approximate_message_count ( ) const

inline

Gets the approximate number of messages in the queue or -1 if unknown.

Returns

The approximate number of messages in the queue or -1 if unknown.

Call the download_attributes function to retrieve this data from the queue service.

clear() [1/2]

void azure::storage::cloud_queue::clear ( )

inline

Deletes all the messages in the queue.

clear() [2/2]

void azure::storage::cloud_queue::clear ( const queue_request_options &  options, operation_context  context  )

inline

Deletes all the messages in the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

clear_async() [1/2]

pplx::task<void> azure::storage::cloud_queue::clear_async ( )

inline

Intitiates an asynchronous operation that deletes all the messages in the queue.

Returns

A pplx::task object that represents the current operation.

clear_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_queue::clear_async	(	const queue_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation that deletes all the messages in the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.

create() [1/2]

void azure::storage::cloud_queue::create ( )

inline

Creates the queue.

create() [2/2]

void azure::storage::cloud_queue::create ( const queue_request_options &  options, operation_context  context  )

inline

Creates the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

create_async() [1/2]

pplx::task<void> azure::storage::cloud_queue::create_async ( )

inline

Intitiates an asynchronous operation to create the queue.

Returns

A pplx::task object that represents the current operation.

create_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_queue::create_async	(	const queue_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to create the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.

create_if_not_exists() [1/2]

bool azure::storage::cloud_queue::create_if_not_exists ( )

inline

Creates the queue if it does not already exist.

create_if_not_exists() [2/2]

bool azure::storage::cloud_queue::create_if_not_exists ( const queue_request_options &  options, operation_context  context  )

inline

Creates the queue if it does not already exist.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

create_if_not_exists_async() [1/2]

pplx::task<bool> azure::storage::cloud_queue::create_if_not_exists_async ( )

inline

Intitiates an asynchronous operation to create the queue if it does not already exist.

Returns

A pplx::task object that represents the current operation.

create_if_not_exists_async() [2/2]

WASTORAGE_API pplx::task<bool> azure::storage::cloud_queue::create_if_not_exists_async	(	const queue_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to create the queue if it does not already exist.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.

delete_message() [1/2]

void azure::storage::cloud_queue::delete_message ( cloud_queue_message &  message )

inline

Deletes the given message from the queue.

Parameters

message

The message to delete.

delete_message() [2/2]

void azure::storage::cloud_queue::delete_message ( cloud_queue_message &  message, queue_request_options &  options, operation_context  context  )

inline

Deletes the given message from the queue.

Parameters

message	The message to delete.
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

delete_message_async() [1/2]

pplx::task<void> azure::storage::cloud_queue::delete_message_async ( cloud_queue_message &  message )

inline

Intitiates an asynchronous operation that deletes the given message from the queue.

Parameters

message

The message to delete.

Returns

A pplx::task object that represents the current operation.

delete_message_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_queue::delete_message_async	(	cloud_queue_message &	message,
		queue_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation that deletes the given message from the queue.

Parameters

message	The message to delete.
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.

delete_queue() [1/2]

void azure::storage::cloud_queue::delete_queue ( )

inline

Deletes the queue.

delete_queue() [2/2]

void azure::storage::cloud_queue::delete_queue ( const queue_request_options &  options, operation_context  context  )

inline

Deletes the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

delete_queue_async() [1/2]

pplx::task<void> azure::storage::cloud_queue::delete_queue_async ( )

inline

Intitiates an asynchronous operation to delete the queue.

Returns

A pplx::task object that represents the current operation.

delete_queue_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_queue::delete_queue_async	(	const queue_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to delete the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.

delete_queue_if_exists() [1/2]

bool azure::storage::cloud_queue::delete_queue_if_exists ( )

inline

Deletes the queue if it exists.

delete_queue_if_exists() [2/2]

bool azure::storage::cloud_queue::delete_queue_if_exists ( const queue_request_options &  options, operation_context  context  )

inline

Deletes the queue if it exists.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

delete_queue_if_exists_async() [1/2]

pplx::task<bool> azure::storage::cloud_queue::delete_queue_if_exists_async ( )

inline

Intitiates an asynchronous operation to delete the queue if it exists.

Returns

A pplx::task object that represents the current operation.

delete_queue_if_exists_async() [2/2]

WASTORAGE_API pplx::task<bool> azure::storage::cloud_queue::delete_queue_if_exists_async	(	const queue_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation to delete the queue if it exists.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.

download_attributes() [1/2]

void azure::storage::cloud_queue::download_attributes ( )

inline

Retrieves the user-defined metadata for the queue.

download_attributes() [2/2]

void azure::storage::cloud_queue::download_attributes ( const queue_request_options &  options, operation_context  context  )

inline

Retrieves the user-defined metadata for the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

download_attributes_async() [1/2]

pplx::task<void> azure::storage::cloud_queue::download_attributes_async ( )

inline

Intitiates an asynchronous operation that retrieves the user-defined metadata for the queue.

Returns

A pplx::task object that represents the current operation.

download_attributes_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_queue::download_attributes_async	(	const queue_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation that retrieves the user-defined metadata for the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.

download_permissions() [1/2]

queue_permissions azure::storage::cloud_queue::download_permissions ( ) const

inline

Retrieves the shared access policies for the queue.

download_permissions() [2/2]

queue_permissions azure::storage::cloud_queue::download_permissions ( const queue_request_options &  options, operation_context  context  ) const

inline

Retrieves the shared access policies for the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

download_permissions_async() [1/2]

pplx::task<queue_permissions> azure::storage::cloud_queue::download_permissions_async ( ) const

inline

Intitiates an asynchronous operation that retrieves the shared access policies for the queue.

Returns

A pplx::task object of type azure::storage::queue_permissions that represents the current operation.

download_permissions_async() [2/2]

WASTORAGE_API pplx::task<queue_permissions> azure::storage::cloud_queue::download_permissions_async	(	const queue_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation that retrieves the shared access policies for the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type azure::storage::queue_permissions that represents the current operation.

exists() [1/2]

bool azure::storage::cloud_queue::exists ( ) const

inline

Checks for the existence of the queue.

exists() [2/2]

bool azure::storage::cloud_queue::exists ( const queue_request_options &  options, operation_context  context  ) const

inline

Checks for the existence of the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

exists_async() [1/2]

pplx::task<bool> azure::storage::cloud_queue::exists_async ( ) const

inline

Intitiates an asynchronous operation to check for the existence of the queue.

Returns

A pplx::task object that represents the current operation.

exists_async() [2/2]

WASTORAGE_API pplx::task<bool> azure::storage::cloud_queue::exists_async	(	const queue_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation to check for the existence of the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.

get_message() [1/2]

cloud_queue_message azure::storage::cloud_queue::get_message ( )

inline

Retrieves a message from the front of the queue

Returns

An azure::storage::cloud_queue_message object.

get_message() [2/2]

cloud_queue_message azure::storage::cloud_queue::get_message ( std::chrono::seconds  visibility_timeout, queue_request_options &  options, operation_context  context  )

inline

Retrieves a message from the front of the queue

Parameters

visibility_timeout	The length of time from now during which the message will be invisible.
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

An azure::storage::cloud_queue_message object.

get_message_async() [1/2]

pplx::task<cloud_queue_message> azure::storage::cloud_queue::get_message_async ( )

inline

Intitiates an asynchronous operation that retrieves a message from the front of the queue

Returns

A pplx::task object of type azure::storage::cloud_queue_message that represents the current operation.

get_message_async() [2/2]

WASTORAGE_API pplx::task<cloud_queue_message> azure::storage::cloud_queue::get_message_async	(	std::chrono::seconds	visibility_timeout,
		queue_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation that retrieves a message from the front of the queue

Parameters

visibility_timeout	The length of time from now during which the message will be invisible.
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type azure::storage::cloud_queue_message that represents the current operation.

get_messages() [1/2]

std::vector<cloud_queue_message> azure::storage::cloud_queue::get_messages ( size_t  message_count )

inline

Retrieves the specified number of messages from the front of the queue.

Parameters

message_count

The number of messages to retrieve.

Returns

An enumerable collection of azure::storage::cloud_queue_message objects.

get_messages() [2/2]

std::vector<cloud_queue_message> azure::storage::cloud_queue::get_messages ( size_t  message_count, std::chrono::seconds  visibility_timeout, queue_request_options &  options, operation_context  context  )

inline

Intitiates an asynchronous operation that retrieves the specified number of messages from the front of the queue.

Parameters

message_count	The number of messages to retrieve.
visibility_timeout	The length of time from now during which the message will be invisible.
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

An enumerable collection of azure::storage::cloud_queue_message objects.

get_messages_async() [1/2]

pplx::task<std::vector<cloud_queue_message> > azure::storage::cloud_queue::get_messages_async ( size_t  message_count )

inline

Intitiates an asynchronous operation that retrieves the specified number of messages from the front of the queue.

Parameters

message_count

The number of messages to retrieve.

Returns

A pplx::task object of type std::vector, of type azure::storage::cloud_queue_message, that represents the current operation.

get_messages_async() [2/2]

WASTORAGE_API pplx::task<std::vector<cloud_queue_message> > azure::storage::cloud_queue::get_messages_async	(	size_t	message_count,
		std::chrono::seconds	visibility_timeout,
		queue_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation that retrieves the specified number of messages from the front of the queue.

Parameters

message_count	The number of messages to retrieve.
visibility_timeout	The length of time from now during which the message will be invisible.
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type std::vector, of type azure::storage::cloud_queue_message, that represents the current operation.

get_shared_access_signature() [1/2]

utility::string_t azure::storage::cloud_queue::get_shared_access_signature ( const queue_shared_access_policy &  policy ) const

inline

Gets a shared access signature for the queue.

Parameters

policy

The access policy for the shared access signature.

Returns

A string containing a shared access signature.

get_shared_access_signature() [2/2]

WASTORAGE_API utility::string_t azure::storage::cloud_queue::get_shared_access_signature	(	const queue_shared_access_policy &	policy,
		const utility::string_t &	stored_policy_identifier
	)		const

Gets a shared access signature for the queue.

Parameters

policy	The access policy for the shared access signature.
stored_policy_identifier	A queue-level access policy.

Returns

A string containing a shared access signature.

metadata() [1/2]

cloud_metadata& azure::storage::cloud_queue::metadata ( )

inline

Gets an unordered map containing user-defined key/value pairs associated with the queue.

Returns

An unordered map containing user-defined key/value pairs associated with the queue.

Call the download_attributes function to retrieve this data from the queue service.

metadata() [2/2]

const cloud_metadata& azure::storage::cloud_queue::metadata ( ) const

inline

Gets an unordered map containing user-defined key/value pairs associated with the queue.

Returns

An unordered map containing user-defined key/value pairs associated with the queue.

Call the download_attributes function to retrieve this data from the queue service.

name()

const utility::string_t& azure::storage::cloud_queue::name ( ) const

inline

Gets the name of the queue.

Returns

The name of the queue.

peek_message() [1/2]

cloud_queue_message azure::storage::cloud_queue::peek_message ( ) const

inline

Peeks a message from the front of the queue

Returns

An azure::storage::cloud_queue_message object.

peek_message() [2/2]

cloud_queue_message azure::storage::cloud_queue::peek_message ( const queue_request_options &  options, operation_context  context  ) const

inline

Peeks a message from the front of the queue

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

An azure::storage::cloud_queue_message object.

peek_message_async() [1/2]

pplx::task<cloud_queue_message> azure::storage::cloud_queue::peek_message_async ( ) const

inline

Intitiates an asynchronous operation that peeks a message from the front of the queue

Returns

A pplx::task object of type azure::storage::cloud_queue_message that represents the current operation.

peek_message_async() [2/2]

WASTORAGE_API pplx::task<cloud_queue_message> azure::storage::cloud_queue::peek_message_async	(	const queue_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation that peeks a message from the front of the queue

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type azure::storage::cloud_queue_message that represents the current operation.

peek_messages() [1/2]

std::vector<cloud_queue_message> azure::storage::cloud_queue::peek_messages ( size_t  message_count ) const

inline

Retrieves the specified number of messages from the front of the queue, without affecting message visibility.

Parameters

message_count

The number of messages to be retrieved.

Returns

An enumerable collection of azure::storage::cloud_queue_message objects.

peek_messages() [2/2]

std::vector<cloud_queue_message> azure::storage::cloud_queue::peek_messages ( size_t  message_count, const queue_request_options &  options, operation_context  context  ) const

inline

Retrieves the specified number of messages from the front of the queue, without affecting message visibility.

Parameters

message_count	The number of messages to be retrieved.
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

An enumerable collection of azure::storage::cloud_queue_message objects.

peek_messages_async() [1/2]

pplx::task<std::vector<cloud_queue_message> > azure::storage::cloud_queue::peek_messages_async ( size_t  message_count ) const

inline

Intitiates an asynchronous operation that retrieves the specified number of messages from the front of the queue, without affecting message visibility.

Parameters

message_count

The number of messages to be retrieved.

Returns

A pplx::task object of type azure::storage::cloud_queue_message that represents the current operation.

peek_messages_async() [2/2]

WASTORAGE_API pplx::task<std::vector<cloud_queue_message> > azure::storage::cloud_queue::peek_messages_async	(	size_t	message_count,
		const queue_request_options &	options,
		operation_context	context
	)		const

Intitiates an asynchronous operation that retrieves the specified number of messages from the front of the queue, without affecting message visibility.

Parameters

message_count	The number of messages to be retrieved.
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object of type std::vector, of type azure::storage::cloud_queue_message, that represents the current operation.

queue_message_uri()

const storage_uri& azure::storage::cloud_queue::queue_message_uri ( ) const

inline

Return the storage uri for queue message's operations.

storage uri for queue message's operations.

service_client()

const cloud_queue_client& azure::storage::cloud_queue::service_client ( ) const

inline

Gets the Queue service client that specifies the endpoint for the queue service.

Returns

The azure::storage::cloud_queue_client object that specifies the endpoint for the queue service.

set_metadata()

void azure::storage::cloud_queue::set_metadata ( cloud_metadata  value )

inline

Sets an unordered map containing user-defined key/value pairs associated with the queue.

Parameters

value

An unordered map containing user-defined key/value pairs associated with the queue.

Call the upload_attributes function to save this data to the queue service.

update_message() [1/2]

void azure::storage::cloud_queue::update_message ( cloud_queue_message &  message, std::chrono::seconds  visibility_timeout, bool  update_content  )

inline

Updates the visibility timeout and the contents of the specified message in the queue.

Parameters

message	The message to update.
visibility_timeout	The time interval, in seconds, after which the message becomes visible again, unless it has been deleted.
update_content	true to update the content of the message.

update_message() [2/2]

void azure::storage::cloud_queue::update_message ( cloud_queue_message &  message, std::chrono::seconds  visibility_timeout, bool  update_content, queue_request_options &  options, operation_context  context  )

inline

Updates the visibility timeout and the contents of the specified message in the queue.

Parameters

message	The message to update.
visibility_timeout	The time interval, in seconds, after which the message becomes visible again, unless it has been deleted.
update_content	true to update the content of the message.
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

update_message_async() [1/2]

pplx::task<void> azure::storage::cloud_queue::update_message_async ( cloud_queue_message &  message, std::chrono::seconds  visibility_timeout, bool  update_content  )

inline

Intitiates an asynchronous operation that updates the visibility timeout and the contents of the specified message in the queue.

Parameters

message	The message to update.
visibility_timeout	The time interval, in seconds, after which the message becomes visible again, unless it has been deleted.
update_content	true to update the content of the message.

Returns

A pplx::task object that represents the current operation.

update_message_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_queue::update_message_async	(	cloud_queue_message &	message,
		std::chrono::seconds	visibility_timeout,
		bool	update_content,
		queue_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation that updates the visibility timeout and the contents of the specified message in the queue.

Parameters

message	The message to update.
visibility_timeout	The time interval, in seconds, after which the message becomes visible again, unless it has been deleted.
update_content	true to update the content of the message.
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.

upload_metadata() [1/2]

void azure::storage::cloud_queue::upload_metadata ( )

inline

Sets the user-defined metadata for the queue.

upload_metadata() [2/2]

void azure::storage::cloud_queue::upload_metadata ( const queue_request_options &  options, operation_context  context  )

inline

Sets the user-defined metadata for the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

upload_metadata_async() [1/2]

pplx::task<void> azure::storage::cloud_queue::upload_metadata_async ( )

inline

Intitiates an asynchronous operation that sets the user-defined metadata for the queue.

Returns

A pplx::task object that represents the current operation.

upload_metadata_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_queue::upload_metadata_async	(	const queue_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation that sets the user-defined metadata for the queue.

Parameters

options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.

upload_permissions() [1/2]

void azure::storage::cloud_queue::upload_permissions ( const queue_permissions &  permissions )

inline

Sets permissions for the queue.

Parameters

permissions

The access control list to associate with this queue

upload_permissions() [2/2]

void azure::storage::cloud_queue::upload_permissions ( const queue_permissions &  permissions, const queue_request_options &  options, operation_context  context  )

inline

Sets permissions for the queue.

Parameters

permissions	The access control list to associate with this queue
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

upload_permissions_async() [1/2]

pplx::task<void> azure::storage::cloud_queue::upload_permissions_async ( const queue_permissions &  permissions )

inline

Intitiates an asynchronous operation that sets permissions for the queue.

Parameters

permissions

The access control list to associate with this queue

Returns

A pplx::task object that represents the current operation.

upload_permissions_async() [2/2]

WASTORAGE_API pplx::task<void> azure::storage::cloud_queue::upload_permissions_async	(	const queue_permissions &	permissions,
		const queue_request_options &	options,
		operation_context	context
	)

Intitiates an asynchronous operation that sets permissions for the queue.

Parameters

permissions	The access control list to associate with this queue
options	An azure::storage::queue_request_options object that specifies additional options for the request.
context	An azure::storage::operation_context object that represents the context for the current operation.

Returns

A pplx::task object that represents the current operation.

uri()

const storage_uri& azure::storage::cloud_queue::uri ( ) const

inline

Gets the queue URI for all locations.

Returns

An azure::storage::storage_uri containing the queue URI for all locations.