PureBasic

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

PureBasic

IncludeFile "CkRest.pb"
IncludeFile "CkStringBuilder.pb"

Procedure ChilkatExample()

    success.i = 0

    ; 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.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"<yournamespace>.servicebus.windows.net",443,1,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; 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.i = CkStringBuilder::ckCreate()
    If sbToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckLoadFile(sbToken,"qa_data/tokens/serviceBusSas.txt","utf-8")

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

    ; Build the path..
    sbPath.i = CkStringBuilder::ckCreate()
    If sbPath.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbPath,"/{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}")
    numReplaced.i = CkStringBuilder::ckReplace(sbPath,"{topicPath}",topicName)
    numReplaced = CkStringBuilder::ckReplace(sbPath,"{subscriptionName}",subscriptionName)
    numReplaced = CkStringBuilder::ckReplace(sbPath,"{messageId|sequenceNumber}",messageId)
    numReplaced = CkStringBuilder::ckReplace(sbPath,"{lockToken}",lockToken)

    ; Add a timeout parameter.
    CkRest::ckAddQueryParam(rest,"timeout","20")

    ; Use the PUT HTTP verb to unlock the message.
    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestNoBodySb(rest,"PUT",CkStringBuilder::ckGetAsString(sbPath),sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbToken)
        CkStringBuilder::ckDispose(sbPath)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    Debug "Response Status Code = " + Str(CkRest::ckResponseStatusCode(rest))

    ; Check for a success response.
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug CkRest::ckLastRequestStartLine(rest)
        Debug CkRest::ckLastRequestHeader(rest)
        Debug CkStringBuilder::ckGetAsString(sbResponseBody)
        Debug "Failed."
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbToken)
        CkStringBuilder::ckDispose(sbPath)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    ; If successful, the response body would be empty..
    Debug "Success."


    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbToken)
    CkStringBuilder::ckDispose(sbPath)
    CkStringBuilder::ckDispose(sbResponseBody)


    ProcedureReturn
EndProcedure