azure::storage::cloud_queue_message Class Reference

Represents a message in a Windows Azure queue. More...

Public Member Functions
	cloud_queue_message ()
	Initializes a new instance of the azure::storage::cloud_queue_message class. More...
	cloud_queue_message (utility::string_t content)
	Initializes a new instance of the azure::storage::cloud_queue_message class, with text content. More...
	cloud_queue_message (const std::vector< uint8_t > &content)
	Initializes a new instance of the azure::storage::cloud_queue_message class with the specified raw data. More...
	cloud_queue_message (utility::string_t id, utility::string_t pop_receipt)
	Initializes a new instance of the azure::storage::cloud_queue_message class. More...
const utility::string_t	content_as_string () const
	Gets the content of the message as text. More...
const std::vector< uint8_t >	content_as_binary () const
	Gets the content of the message as raw data. More...
void	set_content (utility::string_t value)
	Sets the content of this message. More...
void	set_content (const std::vector< uint8_t > &value)
	Sets the content of this message. More...
const utility::string_t &	id () const
	Gets the unique ID of the message. More...
const utility::string_t &	pop_receipt () const
	Gets the message's pop receipt. More...
utility::datetime	expiration_time () const
	Returns the expiration time for the message, based on its time-to-live. More...
utility::datetime	insertion_time () const
	Returns the time that the message was inserted into the queue. More...
utility::datetime	next_visible_time () const
	Returns the next time that the message will be visible. More...
int	dequeue_count () const
	Returns the dequeue count indicating the number of times the message has been retrieved from the queue. More...

Static Public Attributes
static const size_t	max_message_size = 64U * 1024U
	The maximum message size, in bytes. More...
static WASTORAGE_API const std::chrono::seconds	max_time_to_live
	The maximum amount of time a message is kept in the queue, in seconds. More...
static const int	max_number_of_messages_to_peek = 32
	The maximum number of messages that can be peeked from the queue at a time. More...

Detailed Description

Represents a message in a Windows Azure queue.

Constructor & Destructor Documentation

cloud_queue_message() [1/4]

azure::storage::cloud_queue_message::cloud_queue_message ( )

inline

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

cloud_queue_message() [2/4]

azure::storage::cloud_queue_message::cloud_queue_message ( utility::string_t  content )

inlineexplicit

Initializes a new instance of the azure::storage::cloud_queue_message class, with text content.

Parameters

content

The content of the message.

cloud_queue_message() [3/4]

azure::storage::cloud_queue_message::cloud_queue_message ( const std::vector< uint8_t > &  content )

inlineexplicit

Initializes a new instance of the azure::storage::cloud_queue_message class with the specified raw data.

Parameters

content

The content of the message as raw data.

cloud_queue_message() [4/4]

azure::storage::cloud_queue_message::cloud_queue_message ( utility::string_t  id, utility::string_t  pop_receipt  )

inline

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

Parameters

id	The unique ID of the message.
pop_receipt	The pop receipt token.

Member Function Documentation

content_as_binary()

const std::vector<uint8_t> azure::storage::cloud_queue_message::content_as_binary ( ) const

inline

Gets the content of the message as raw data.

Returns

The content of the message as raw data.

content_as_string()

const utility::string_t azure::storage::cloud_queue_message::content_as_string ( ) const

inline

Gets the content of the message as text.

Returns

The content of the message as text.

dequeue_count()

int azure::storage::cloud_queue_message::dequeue_count ( ) const

inline

Returns the dequeue count indicating the number of times the message has been retrieved from the queue.

Returns

The dequeue count.

expiration_time()

utility::datetime azure::storage::cloud_queue_message::expiration_time ( ) const

inline

Returns the expiration time for the message, based on its time-to-live.

Returns

The expiration time for the message.

id()

const utility::string_t& azure::storage::cloud_queue_message::id ( ) const

inline

Gets the unique ID of the message.

Returns

The unique ID of the message.

insertion_time()

utility::datetime azure::storage::cloud_queue_message::insertion_time ( ) const

inline

Returns the time that the message was inserted into the queue.

Returns

The time that the message was inserted into the queue.

next_visible_time()

utility::datetime azure::storage::cloud_queue_message::next_visible_time ( ) const

inline

Returns the next time that the message will be visible.

Returns

The next time that the message will be visible.

pop_receipt()

const utility::string_t& azure::storage::cloud_queue_message::pop_receipt ( ) const

inline

Gets the message's pop receipt.

Returns

The pop receipt value.

set_content() [1/2]

void azure::storage::cloud_queue_message::set_content ( utility::string_t  value )

inline

Sets the content of this message.

Parameters

value

The new message content.

set_content() [2/2]

void azure::storage::cloud_queue_message::set_content ( const std::vector< uint8_t > &  value )

inline

Sets the content of this message.

Parameters

value

The new message content.

Member Data Documentation

max_message_size

const size_t azure::storage::cloud_queue_message::max_message_size = 64U * 1024U

static

The maximum message size, in bytes.

max_number_of_messages_to_peek

const int azure::storage::cloud_queue_message::max_number_of_messages_to_peek = 32

static

The maximum number of messages that can be peeked from the queue at a time.

max_time_to_live

WASTORAGE_API const std::chrono::seconds azure::storage::cloud_queue_message::max_time_to_live

static

The maximum amount of time a message is kept in the queue, in seconds.