Rust

Azure Service Bus - Unlock Message

See more Azure Service Bus Examples

Shows how to unlock a message for processing by other receivers on a specified queue or subscription. This operation deletes the lock object, causing the message to be unlocked.

For more information, see https://docs.microsoft.com/en-us/rest/api/servicebus/unlock-message

Rust

// Note: Requires Chilkat v9.5.0.65 or greater.

// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// Make the initial connection.
// A single REST object, once connected, can be used for many Azure Service Bus REST API calls.
// The auto-reconnect indicates that if the already-established HTTPS connection is closed,
// then it will be automatically re-established as needed.
let rest = chilkat::Rest::new();
let b_auto_reconnect = true;
if rest.connect("<yournamespace>.servicebus.windows.net", 443, true, b_auto_reconnect).is_err() {
    println!("{}", rest.last_error_text());
    return;
}

// Let's load a previously computed SAS token and use it.
// See Azure Shared Access Signature for an example to genenerate an Azure SAS token.
let sb_token = chilkat::StringBuilder::new();
let _ = sb_token.load_file("qa_data/tokens/serviceBusSas.txt", "utf-8");

// Tell the REST object to use the Azure Shared Access Signature for authorization.
let _ = sb_token.prepend("SharedAccessSignature ");
let _ = rest.add_header("Authorization", &sb_token.get_as_string().unwrap_or_default());

// ----------------------------------------------------------------------------------------------
// The code above this comment could be placed inside a function/subroutine within the application
// because the connection does not need to be made for every request.  Once the connection is made
// the app may send many requests..
// ----------------------------------------------------------------------------------------------

// To unlock a message, we'll need either the SequenceNumber or MessageId.
// When the message was locked, the SequenceNumber and MessageId of the locked message
// was returned in the HTTP response header named "BrokerProperties, which contained
// JSON such as the following:

// 	{
// 	  "DeliveryCount": 2,
// 	  "EnqueuedSequenceNumber": 3000003,
// 	  "EnqueuedTimeUtc": "Wed, 07 Dec 2016 17:42:48 GMT",
// 	  "Label": "M2",
// 	  "LockToken": "0a13ee8a-be32-4458-89e0-5e1401caa6a0",
// 	  "LockedUntilUtc": "Wed, 07 Dec 2016 18:13:12 GMT",
// 	  "MessageId": "7bea513a6ddb49089e07bfbee26d85bd",
// 	  "SequenceNumber": 3,
// 	  "State": "Active",
// 	  "TimeToLive": 922337203685.47754
// 	}

// The path for unlocking a message is constructed as follows, depending on
// whether it is a message on a queue or subscription:
// 
// (for a queue)
// /{queuePath}/messages/{messageId|sequenceNumber}/{lockToken}
// 
// (for a subscription)
// /{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}

// This example will build a path to unlock a message contained in a subscription.
let topic_name = "gilaMonster".to_string();
let subscription_name = "feedings".to_string();
let message_id = "7bea513a6ddb49089e07bfbee26d85bd".to_string();
let lock_token = "0a13ee8a-be32-4458-89e0-5e1401caa6a0".to_string();

// Build the path..
let sb_path = chilkat::StringBuilder::new();
let _ = sb_path.append("/{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}");
let mut num_replaced = sb_path.replace("{topicPath}", &topic_name);
num_replaced = sb_path.replace("{subscriptionName}", &subscription_name);
num_replaced = sb_path.replace("{messageId|sequenceNumber}", &message_id);
num_replaced = sb_path.replace("{lockToken}", &lock_token);

// Add a timeout parameter.
let _ = rest.add_query_param("timeout", "20");

// Use the PUT HTTP verb to unlock the message.
let sb_response_body = chilkat::StringBuilder::new();
if rest.full_request_no_body_sb("PUT", &sb_path.get_as_string().unwrap_or_default(), &sb_response_body).is_err() {
    println!("{}", rest.last_error_text());
    return;
}

println!("Response Status Code = {}", rest.response_status_code());

// Check for a success response.
if rest.response_status_code() != 200 {
    println!("{}", rest.last_request_start_line());
    println!("{}", rest.last_request_header());
    println!("{}", sb_response_body.get_as_string().unwrap_or_default());
    println!("Failed.");
    return;
}

// If successful, the response body would be empty..
println!("Success.");