Unicode C

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

Unicode C

#include <C_CkRestW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkRestW rest;
    BOOL bAutoReconnect;
    HCkStringBuilderW sbToken;
    const wchar_t *topicName;
    const wchar_t *subscriptionName;
    const wchar_t *messageId;
    const wchar_t *lockToken;
    HCkStringBuilderW sbPath;
    int numReplaced;
    HCkStringBuilderW sbResponseBody;

    success = FALSE;

    // 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.
    rest = CkRestW_Create();
    bAutoReconnect = TRUE;
    success = CkRestW_Connect(rest,L"<yournamespace>.servicebus.windows.net",443,TRUE,bAutoReconnect);
    if (success != TRUE) {
        wprintf(L"%s\n",CkRestW_lastErrorText(rest));
        CkRestW_Dispose(rest);
        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.
    sbToken = CkStringBuilderW_Create();
    CkStringBuilderW_LoadFile(sbToken,L"qa_data/tokens/serviceBusSas.txt",L"utf-8");

    // Tell the REST object to use the Azure Shared Access Signature for authorization.
    CkStringBuilderW_Prepend(sbToken,L"SharedAccessSignature ");
    CkRestW_AddHeader(rest,L"Authorization",CkStringBuilderW_getAsString(sbToken));

    // ----------------------------------------------------------------------------------------------
    // 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.
    topicName = L"gilaMonster";
    subscriptionName = L"feedings";
    messageId = L"7bea513a6ddb49089e07bfbee26d85bd";
    lockToken = L"0a13ee8a-be32-4458-89e0-5e1401caa6a0";

    // Build the path..
    sbPath = CkStringBuilderW_Create();
    CkStringBuilderW_Append(sbPath,L"/{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}");
    numReplaced = CkStringBuilderW_Replace(sbPath,L"{topicPath}",topicName);
    numReplaced = CkStringBuilderW_Replace(sbPath,L"{subscriptionName}",subscriptionName);
    numReplaced = CkStringBuilderW_Replace(sbPath,L"{messageId|sequenceNumber}",messageId);
    numReplaced = CkStringBuilderW_Replace(sbPath,L"{lockToken}",lockToken);

    // Add a timeout parameter.
    CkRestW_AddQueryParam(rest,L"timeout",L"20");

    // Use the PUT HTTP verb to unlock the message.
    sbResponseBody = CkStringBuilderW_Create();
    success = CkRestW_FullRequestNoBodySb(rest,L"PUT",CkStringBuilderW_getAsString(sbPath),sbResponseBody);
    if (success != TRUE) {
        wprintf(L"%s\n",CkRestW_lastErrorText(rest));
        CkRestW_Dispose(rest);
        CkStringBuilderW_Dispose(sbToken);
        CkStringBuilderW_Dispose(sbPath);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    wprintf(L"Response Status Code = %d\n",CkRestW_getResponseStatusCode(rest));

    // Check for a success response.
    if (CkRestW_getResponseStatusCode(rest) != 200) {
        wprintf(L"%s\n",CkRestW_lastRequestStartLine(rest));
        wprintf(L"%s\n",CkRestW_lastRequestHeader(rest));
        wprintf(L"%s\n",CkStringBuilderW_getAsString(sbResponseBody));
        wprintf(L"Failed.\n");
        CkRestW_Dispose(rest);
        CkStringBuilderW_Dispose(sbToken);
        CkStringBuilderW_Dispose(sbPath);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    // If successful, the response body would be empty..
    wprintf(L"Success.\n");


    CkRestW_Dispose(rest);
    CkStringBuilderW_Dispose(sbToken);
    CkStringBuilderW_Dispose(sbPath);
    CkStringBuilderW_Dispose(sbResponseBody);

    }