(Tcl) 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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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.
set rest [new_CkRest]

set bAutoReconnect 1
set success [CkRest_Connect $rest "<yournamespace>.servicebus.windows.net" 443 1 $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

# 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.
set sbToken [new_CkStringBuilder]

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

# Build the path..
set sbPath [new_CkStringBuilder]

CkStringBuilder_Append $sbPath "/{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}"
set numReplaced [CkStringBuilder_Replace $sbPath "{topicPath}" $topicName]
set numReplaced [CkStringBuilder_Replace $sbPath "{subscriptionName}" $subscriptionName]
set numReplaced [CkStringBuilder_Replace $sbPath "{messageId|sequenceNumber}" $messageId]
set numReplaced [CkStringBuilder_Replace $sbPath "{lockToken}" $lockToken]

# Add a timeout parameter.
CkRest_AddQueryParam $rest "timeout" "20"

# Use the PUT HTTP verb to unlock the message.
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "PUT" [CkStringBuilder_getAsString $sbPath] $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkStringBuilder $sbToken
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbResponseBody
    exit
}

puts "Response Status Code = [CkRest_get_ResponseStatusCode $rest]"

# Check for a success response.
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts [CkRest_lastRequestStartLine $rest]
    puts [CkRest_lastRequestHeader $rest]
    puts [CkStringBuilder_getAsString $sbResponseBody]
    puts "Failed."
    delete_CkRest $rest
    delete_CkStringBuilder $sbToken
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbResponseBody
    exit
}

# If successful, the response body would be empty..
puts "Success."

delete_CkRest $rest
delete_CkStringBuilder $sbToken
delete_CkStringBuilder $sbPath
delete_CkStringBuilder $sbResponseBody