| Title: | Interface to 'Azure Queue Storage' |
|---|---|
| Description: | An interface to 'Azure Queue Storage'. This is a cloud service for storing large numbers of messages, for example from automated sensors, that can be accessed remotely via authenticated calls using HTTP or HTTPS. Queue storage is often used to create a backlog of work to process asynchronously. Part of the 'AzureR' family of packages. |
| Authors: | Hong Ooi [aut, cre], Microsoft [cph] |
| Maintainer: | Hong Ooi <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 1.0.1.9000 |
| Built: | 2024-12-22 03:02:16 UTC |
| Source: | https://github.com/azure/azureqstor |
Create a queue endpoint object
queue_endpoint( endpoint, key = NULL, token = NULL, sas = NULL, api_version = getOption("azure_storage_api_version") )queue_endpoint( endpoint, key = NULL, token = NULL, sas = NULL, api_version = getOption("azure_storage_api_version") )
endpoint |
The URL (hostname) for the endpoint, of the form |
key |
The access key for the storage account. |
token |
An Azure Active Directory (AAD) authentication token. This can be either a string, or an object of class AzureToken created by AzureRMR::get_azure_token. The latter is the recommended way of doing it, as it allows for automatic refreshing of expired tokens. |
sas |
A shared access signature (SAS) for the account. |
api_version |
The storage API version to use when interacting with the host. Defaults to |
This is the queue storage counterpart to the endpoint functions defined in the AzureStor package.
An object of class queue_endpoint, inheriting from storage_endpoint.
AzureStor::storage_endpoint, AzureStor::blob_endpoint, storage_queue
## Not run: # obtaining an endpoint from the storage account resource object AzureRMR::get_azure_login()$ get_subscription("sub_id")$ get_resource_group("rgname")$ get_storage_account("mystorage")$ get_queue_endpoint() # creating an endpoint standalone queue_endpoint("https://mystorage.queue.core.windows.net/", key="access_key") ## End(Not run)## Not run: # obtaining an endpoint from the storage account resource object AzureRMR::get_azure_login()$ get_subscription("sub_id")$ get_resource_group("rgname")$ get_storage_account("mystorage")$ get_queue_endpoint() # creating an endpoint standalone queue_endpoint("https://mystorage.queue.core.windows.net/", key="access_key") ## End(Not run)
This class stores the data, metadata and behaviour associated with a message.
To generate a message object, call one of the methods exposed by the StorageQueue class.
queueThe queue this message is from, an object of class StorageQueue
idThe message ID.
insertion_timeThe message insertion (creation) time.
expiry_timeThe message expiration time.
textThe message text.
receiptA pop receipt. This is present if the message was obtained by means other than peeking, and is required for updating or deleting the message.
next_visible_timeThe time when this message will be next visible.
dequeue_countThe number of times this message has been read.
new()
Creates a new message object. Rather than calling the new method manually, objects of this class should be created via the methods exposed by the StorageQueue object.
QueueMessage$new(message, queue)
messageDetails about the message.
queueObject of class StorageQueue.
delete()
Deletes this message from the queue.
QueueMessage$delete()
NULL, invisibly.
update()
Updates this message in the queue.
This operation can be used to continually extend the invisibility of a queue message. This functionality can be useful if you want a worker role to "lease" a message. For example, if a worker role calls get_messages and recognizes that it needs more time to process a message, it can continually extend the message's invisibility until it is processed. If the worker role were to fail during processing, eventually the message would become visible again and another worker role could process it.
QueueMessage$update(visibility_timeout, text = self$text)
visibility_timeoutThe new visibility timeout (time to when the message will again be visible).
textOptionally, new message text, either a raw or character vector. If a raw vector, it is base64-encoded, and if a character vector, it is collapsed into a single string before being sent to the queue.
The message object, invisibly.
print()
Print method for this class.
QueueMessage$print(...)
...Not currently used.
The message object, invisibly.
clone()
The objects of this class are cloneable with this method.
QueueMessage$clone(deep = FALSE)
deepWhether to make a deep clone.
## Not run: endp <- storage_endpoint("https://mystorage.queue.core.windows.net", key="key") queue <- storage_queue(endp, "queue1") msg <- queue$get_message() msg$update(visibility_timeout=60, text="updated message") msg$delete() ## End(Not run)## Not run: endp <- storage_endpoint("https://mystorage.queue.core.windows.net", key="key") queue <- storage_queue(endp, "queue1") msg <- queue$get_message() msg$update(visibility_timeout=60, text="updated message") msg$delete() ## End(Not run)
Get, list, create, or delete queues.
storage_queue(endpoint, ...) ## S3 method for class 'character' storage_queue( endpoint, key = NULL, token = NULL, sas = NULL, api_version = getOption("azure_storage_api_version"), ... ) ## S3 method for class 'queue_endpoint' storage_queue(endpoint, name, ...) list_storage_queues(endpoint, ...) ## S3 method for class 'character' list_storage_queues( endpoint, key = NULL, token = NULL, sas = NULL, api_version = getOption("azure_storage_api_version"), ... ) ## S3 method for class 'queue_endpoint' list_storage_queues(endpoint, ...) ## S3 method for class 'queue_endpoint' list_storage_containers(endpoint, ...) create_storage_queue(endpoint, ...) ## S3 method for class 'character' create_storage_queue( endpoint, key = NULL, token = NULL, sas = NULL, api_version = getOption("azure_storage_api_version"), ... ) ## S3 method for class 'queue_endpoint' create_storage_queue(endpoint, name, ...) ## S3 method for class 'StorageQueue' create_storage_queue(endpoint, ...) delete_storage_queue(endpoint, ...) ## S3 method for class 'character' delete_storage_queue( endpoint, key = NULL, token = NULL, sas = NULL, api_version = getOption("azure_storage_api_version"), ... ) ## S3 method for class 'queue_endpoint' delete_storage_queue(endpoint, name, ...) ## S3 method for class 'StorageQueue' delete_storage_queue(endpoint, confirm = TRUE, ...)storage_queue(endpoint, ...) ## S3 method for class 'character' storage_queue( endpoint, key = NULL, token = NULL, sas = NULL, api_version = getOption("azure_storage_api_version"), ... ) ## S3 method for class 'queue_endpoint' storage_queue(endpoint, name, ...) list_storage_queues(endpoint, ...) ## S3 method for class 'character' list_storage_queues( endpoint, key = NULL, token = NULL, sas = NULL, api_version = getOption("azure_storage_api_version"), ... ) ## S3 method for class 'queue_endpoint' list_storage_queues(endpoint, ...) ## S3 method for class 'queue_endpoint' list_storage_containers(endpoint, ...) create_storage_queue(endpoint, ...) ## S3 method for class 'character' create_storage_queue( endpoint, key = NULL, token = NULL, sas = NULL, api_version = getOption("azure_storage_api_version"), ... ) ## S3 method for class 'queue_endpoint' create_storage_queue(endpoint, name, ...) ## S3 method for class 'StorageQueue' create_storage_queue(endpoint, ...) delete_storage_queue(endpoint, ...) ## S3 method for class 'character' delete_storage_queue( endpoint, key = NULL, token = NULL, sas = NULL, api_version = getOption("azure_storage_api_version"), ... ) ## S3 method for class 'queue_endpoint' delete_storage_queue(endpoint, name, ...) ## S3 method for class 'StorageQueue' delete_storage_queue(endpoint, confirm = TRUE, ...)
endpoint |
Either a queue endpoint object as created by storage_endpoint, or a character string giving the URL of the endpoint. |
... |
Further arguments passed to lower-level functions. |
key, token, sas
|
If an endpoint object is not supplied, authentication credentials: either an access key, an Azure Active Directory (AAD) token, or a SAS, in that order of priority. |
api_version |
If an endpoint object is not supplied, the storage API version to use when interacting with the host. Currently defaults to |
name |
The name of the queue to get, create, or delete. |
confirm |
For deleting a queue, whether to ask for confirmation. |
You can call these functions in a couple of ways: by passing the full URL of the storage queue, or by passing the endpoint object and the name of the share as a string.
For storage_queue and create_storage_queue, an object of class StorageQueue. For list_storage_queues, a list of such objects.
## Not run: endp <- storage_endpoint("https://mystorage.queue.core.windows.net", key="key") # to talk to an existing queue queue <- storage_queue(endp, "queue1") # to create a new queue queue2 <- create_storage_queue(endp, "queue2") # various ways to delete a queue (will ask for confirmation first) queue2$delete() delete_storage_queue(queue2) delete_storage_queue(endp, "queue2") ## End(Not run)## Not run: endp <- storage_endpoint("https://mystorage.queue.core.windows.net", key="key") # to talk to an existing queue queue <- storage_queue(endp, "queue1") # to create a new queue queue2 <- create_storage_queue(endp, "queue2") # various ways to delete a queue (will ask for confirmation first) queue2$delete() delete_storage_queue(queue2) delete_storage_queue(endp, "queue2") ## End(Not run)
A storage queue holds messages. A queue can contain an unlimited number of messages, each of which can be up to 64KB in size. Messages are generally added to the end of the queue and retrieved from the front of the queue, although first in, first out (FIFO) behavior is not guaranteed.
To generate a queue object, use one of the storage_queue, list_storage_queues or create_storage_queue functions rather than calling the new() method directly.
endpointA queue endpoint object. This contains the account and authentication information for the queue.
nameThe name of the queue.
new()
Initialize the queue object. Rather than calling this directly, you should use one of the storage_queue, list_storage_queues or create_storage_queue functions.
Note that initializing this object is a local operation only. If a queue of the given name does not already exist in the storage account, it has to be created remotely by calling the create method.
StorageQueue$new(endpoint, name)
endpointAn endpoint object.
nameThe name of the queue.
create()
Creates a storage queue in Azure, using the storage endpoint and name from this R6 object.
StorageQueue$create()
The queue object, invisibly.
delete()
Deletes this storage queue in Azure.
StorageQueue$delete(confirm = TRUE)
confirmWhether to ask for confirmation before deleting.
The queue object, invisibly.
clear()
Clears (deletes) all messages in this storage queue.
StorageQueue$clear()
The queue object, invisibly.
get_metadata()
Retrieves user-defined metadata for the queue.
StorageQueue$get_metadata()
A named list of metadata properties.
set_metadata()
Sets user-defined metadata for the queue.
StorageQueue$set_metadata(..., keep_existing = TRUE)
...Name-value pairs to set as metadata.
keep_existingWhether to retain existing metadata information.
A named list of metadata properties, invisibly.
get_message()
Reads a message from the front of the storage queue.
When a message is read, the consumer is expected to process the message and then delete it. After the message is read, it is made invisible to other consumers for a specified interval. If the message has not yet been deleted at the time the interval expires, its visibility is restored, so that another consumer may process it.
StorageQueue$get_message()
A new object of class QueueMessage.
get_messages()
Reads several messages at once from the front of the storage queue.
When a message is read, the consumer is expected to process the message and then delete it. After the message is read, it is made invisible to other consumers for a specified interval. If the message has not yet been deleted at the time the interval expires, its visibility is restored, so that another consumer may process it.
StorageQueue$get_messages(n = 1)
nHow many messages to read. The maximum is 32.
A list of objects of class QueueMessage.
peek_message()
Reads a message from the storage queue, but does not alter its visibility.
Note that a message obtained via the peek_message or peek_messages method will not include a pop receipt, which is required to delete or update it.
StorageQueue$peek_message()
A new object of class QueueMessage.
peek_messages()
Reads several messages at once from the storage queue, without altering their visibility.
Note that a message obtained via the peek_message or peek_messages method will not include a pop receipt, which is required to delete or update it.
StorageQueue$peek_messages(n = 1)
nHow many messages to read. The maximum is 32.
A list of objects of class QueueMessage.
pop_message()
Reads a message from the storage queue, removing it at the same time. This is equivalent to calling get_message and delete_message successively.
StorageQueue$pop_message()
A new object of class QueueMessage.
pop_messages()
Reads several messages at once from the storage queue, and then removes them.
StorageQueue$pop_messages(n = 1)
nHow many messages to read. The maximum is 32.
A list of objects of class QueueMessage.
put_message()
Writes a message to the back of the message queue.
StorageQueue$put_message(text, visibility_timeout = NULL, time_to_live = NULL)
textThe message text, either a raw or character vector. If a raw vector, it is base64-encoded, and if a character vector, it is collapsed into a single string before being sent to the queue.
visibility_timeoutOptional visibility timeout after being read, in seconds. The default is 30 seconds.
time_to_liveOptional message time-to-live, in seconds. The default is 7 days.
The message text, invisibly.
update_message()
Updates a message in the queue. This requires that the message object must include a pop receipt, which is present if it was obtained by means other than peeking.
This operation can be used to continually extend the invisibility of a queue message. This functionality can be useful if you want a worker role to "lease" a message. For example, if a worker role calls get_messages and recognizes that it needs more time to process a message, it can continually extend the message's invisibility until it is processed. If the worker role were to fail during processing, eventually the message would become visible again and another worker role could process it.
StorageQueue$update_message(msg, visibility_timeout, text = msg$text)
msgA message object, of class QueueMessage.
visibility_timeoutThe new visibility timeout (time to when the message will again be visible).
textOptionally, new message text, either a raw or character vector. If a raw vector, it is base64-encoded, and if a character vector, it is collapsed into a single string before being sent to the queue.
The message object, invisibly.
delete_message()
Deletes a message from the queue. This requires that the message object must include a pop receipt, which is present if it was obtained by means other than peeking.
StorageQueue$delete_message(msg)
msgA message object, of class QueueMessage.
print()
Print method for this class.
StorageQueue$print(...)
...Not currently used.
clone()
The objects of this class are cloneable with this method.
StorageQueue$clone(deep = FALSE)
deepWhether to make a deep clone.
## Not run: endp <- storage_endpoint("https://mystorage.queue.core.windows.net", key="key") # to talk to an existing queue queue <- storage_queue(endp, "queue1") # to create a new queue queue2 <- create_storage_queue(endp, "queue2") # various ways to delete a queue (will ask for confirmation first) queue2$delete() delete_storage_queue(queue2) delete_storage_queue(endp, "queue2") # to get all queues in this storage account queue_lst <- list_storage_queues(endp) # working with a queue: put, get, update and delete messages queue$put_message("new message") msg <- queue$get_message() msg$update(visibility_timeout=60, text="updated message") queue$delete_message(msg) # delete_message simply calls the message's delete() method, so this is equivalent msg$delete() # retrieving multiple messages at a time (up to 32) msgs <- queue$get_messages(30) # deleting is still per-message lapply(msgs, function(m) m$delete()) # you can use the process pool from AzureRMR to do this in parallel AzureRMR::init_pool() AzureRMR::pool_lapply(msgs, function(m) m$delete()) AzureRMR::delete_pool() ## End(Not run)## Not run: endp <- storage_endpoint("https://mystorage.queue.core.windows.net", key="key") # to talk to an existing queue queue <- storage_queue(endp, "queue1") # to create a new queue queue2 <- create_storage_queue(endp, "queue2") # various ways to delete a queue (will ask for confirmation first) queue2$delete() delete_storage_queue(queue2) delete_storage_queue(endp, "queue2") # to get all queues in this storage account queue_lst <- list_storage_queues(endp) # working with a queue: put, get, update and delete messages queue$put_message("new message") msg <- queue$get_message() msg$update(visibility_timeout=60, text="updated message") queue$delete_message(msg) # delete_message simply calls the message's delete() method, so this is equivalent msg$delete() # retrieving multiple messages at a time (up to 32) msgs <- queue$get_messages(30) # deleting is still per-message lapply(msgs, function(m) m$delete()) # you can use the process pool from AzureRMR to do this in parallel AzureRMR::init_pool() AzureRMR::pool_lapply(msgs, function(m) m$delete()) AzureRMR::delete_pool() ## End(Not run)