Zig

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

Zig

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    // 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.
    const rest = try chilkat.Rest.init();
    defer rest.deinit();
    const b_auto_reconnect = true;
    rest.connect("<yournamespace>.servicebus.windows.net", 443, true, b_auto_reconnect) catch {
        std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
        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.
    const sb_token = try chilkat.StringBuilder.init();
    defer sb_token.deinit();
    sb_token.loadFile("qa_data/tokens/serviceBusSas.txt", "utf-8") catch {};

    // Tell the REST object to use the Azure Shared Access Signature for authorization.
    sb_token.prepend("SharedAccessSignature ") catch {};
    rest.addHeader("Authorization", try sb_token.getAsString(alloc)) catch {};

    // ----------------------------------------------------------------------------------------------
    // 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.
    const topic_name = "gilaMonster";
    const subscription_name = "feedings";
    const message_id = "7bea513a6ddb49089e07bfbee26d85bd";
    const lock_token = "0a13ee8a-be32-4458-89e0-5e1401caa6a0";

    // Build the path..
    const sb_path = try chilkat.StringBuilder.init();
    defer sb_path.deinit();
    sb_path.append("/{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}") catch {};
    var num_replaced: i32 = 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.
    rest.addQueryParam("timeout", "20") catch {};

    // Use the PUT HTTP verb to unlock the message.
    const sb_response_body = try chilkat.StringBuilder.init();
    defer sb_response_body.deinit();
    rest.fullRequestNoBodySb("PUT", try sb_path.getAsString(alloc), sb_response_body) catch {
        std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
        return;
    };

    std.debug.print("Response Status Code = {d}\n", .{rest.getResponseStatusCode()});

    // Check for a success response.
    if (rest.getResponseStatusCode() != 200) {
        std.debug.print("{s}\n", .{try rest.getLastRequestStartLine(alloc)});
        std.debug.print("{s}\n", .{try rest.getLastRequestHeader(alloc)});
        std.debug.print("{s}\n", .{try sb_response_body.getAsString(alloc)});
        std.debug.print("Failed.\n", .{});
        return;
    }

    // If successful, the response body would be empty..
    std.debug.print("Success.\n", .{});
}