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

C

#include <C_CkRest.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkRest rest;
    BOOL bAutoReconnect;
    HCkStringBuilder sbToken;
    const char *topicName;
    const char *subscriptionName;
    const char *messageId;
    const char *lockToken;
    HCkStringBuilder sbPath;
    int numReplaced;
    HCkStringBuilder 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 = CkRest_Create();
    bAutoReconnect = TRUE;
    success = CkRest_Connect(rest,"<yournamespace>.servicebus.windows.net",443,TRUE,bAutoReconnect);
    if (success != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_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 = CkStringBuilder_Create();
    CkStringBuilder_LoadFile(sbToken,"qa_data/tokens/serviceBusSas.txt","utf-8");

    // Tell the REST object to use the Azure Shared Access Signature for authorization.
    CkStringBuilder_Prepend(sbToken,"SharedAccessSignature ");
    CkRest_AddHeader(rest,"Authorization",CkStringBuilder_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 = "gilaMonster";
    subscriptionName = "feedings";
    messageId = "7bea513a6ddb49089e07bfbee26d85bd";
    lockToken = "0a13ee8a-be32-4458-89e0-5e1401caa6a0";

    // Build the path..
    sbPath = CkStringBuilder_Create();
    CkStringBuilder_Append(sbPath,"/{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}");
    numReplaced = CkStringBuilder_Replace(sbPath,"{topicPath}",topicName);
    numReplaced = CkStringBuilder_Replace(sbPath,"{subscriptionName}",subscriptionName);
    numReplaced = CkStringBuilder_Replace(sbPath,"{messageId|sequenceNumber}",messageId);
    numReplaced = CkStringBuilder_Replace(sbPath,"{lockToken}",lockToken);

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

    // Use the PUT HTTP verb to unlock the message.
    sbResponseBody = CkStringBuilder_Create();
    success = CkRest_FullRequestNoBodySb(rest,"PUT",CkStringBuilder_getAsString(sbPath),sbResponseBody);
    if (success != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbToken);
        CkStringBuilder_Dispose(sbPath);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    printf("Response Status Code = %d\n",CkRest_getResponseStatusCode(rest));

    // Check for a success response.
    if (CkRest_getResponseStatusCode(rest) != 200) {
        printf("%s\n",CkRest_lastRequestStartLine(rest));
        printf("%s\n",CkRest_lastRequestHeader(rest));
        printf("%s\n",CkStringBuilder_getAsString(sbResponseBody));
        printf("Failed.\n");
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbToken);
        CkStringBuilder_Dispose(sbPath);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

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


    CkRest_Dispose(rest);
    CkStringBuilder_Dispose(sbToken);
    CkStringBuilder_Dispose(sbPath);
    CkStringBuilder_Dispose(sbResponseBody);

    }