(PureBasic) Azure Service Bus - Peek-Lock Message (Non-Destructive Read)

See more Azure Service Bus Examples

Shows how to atomically retrieve and lock a message from a queue or subscription for processing. The message is guaranteed not to be delivered to other receivers (on the same queue or subscription only) during the lock duration specified in the queue/subscription description.

For more information, see https://docs.microsoft.com/en-us/rest/api/servicebus/peek-lock-message-non-destructive-read

Chilkat PureBasic Module Download Chilkat PureBasic Module

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

Procedure ChilkatExample()

    ; 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.i = CkRest::ckConnect(rest,"<yournamespace>.servicebus.windows.net",443,1,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; ----------------------------------------------------------------------------------------------
    ; 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..
    ; ----------------------------------------------------------------------------------------------

    ; 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))

    ; ----------------------------------------------------------------------------------------------

    ; Peek-lock a message from the subscription "feedings" in the topic "gilaMonster"
    topicName.s = "gilaMonster"
    subscriptionName.s = "feedings"

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

    CkStringBuilder::ckAppend(sbPath,"/")
    CkStringBuilder::ckAppend(sbPath,topicName)
    CkStringBuilder::ckAppend(sbPath,"/subscriptions/")
    CkStringBuilder::ckAppend(sbPath,subscriptionName)
    CkStringBuilder::ckAppend(sbPath,"/messages/head")

    ; If peek-locking from a queue, the path would be built like this:
    sbQueuePath.i = CkStringBuilder::ckCreate()
    If sbQueuePath.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbQueuePath,"/")
    CkStringBuilder::ckAppend(sbQueuePath,"queueName")
    CkStringBuilder::ckAppend(sbQueuePath,"/messages/head")
    ; This example will use the sbPath..

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

    ; Use the POST HTTP verb to peek-lock the message.
    ; Note that the only difference between the destructive Read-and-Delete and the non-destructive Peek-Lock
    ; is that the HTTP verb.  (POST is for peek-lock, DELETE is fore read-and-delete.)
    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

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

    ; Check for a success response.
    ; CAREFUL: This returns a 201 response instead of a 200 response.  In general, either 200 or 201 should always indicate success.
    If CkRest::ckResponseStatusCode(rest) <> 201
        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(sbQueuePath)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    ; The content of the message is returned in the HTTP response body.
    ; The HTTP response headers contains extra information.  For example:
    jsonBrokerProps.i = CkJsonObject::ckCreate()
    If jsonBrokerProps.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(jsonBrokerProps,CkRest::ckResponseHdrByName(rest,"BrokerProperties"))
    CkJsonObject::setCkEmitCompact(jsonBrokerProps, 0)
    Debug CkJsonObject::ckEmit(jsonBrokerProps)

    ; An example of the BrokerProperties JSON that is returned:

    ; 	{
    ; 	  "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
    ; 	}

    ; Also the "Location" response header contains the URI of the locked message.
    ; This can be used to ulock or delete the message.
    Debug "Location: " + CkRest::ckResponseHdrByName(rest,"Location")

    ; An example of the Location URI:
    ; https://chilkat.servicebus.windows.net/gilamonster/subscriptions/feedings/messages/3/0a13ee8a-be32-4458-89e0-5e1401caa6a0

    ; If successful, the message is the contents of the response body.
    message.s = CkStringBuilder::ckGetAsString(sbResponseBody)
    Debug "Received message: " + message

    Debug "Success."


    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbToken)
    CkStringBuilder::ckDispose(sbPath)
    CkStringBuilder::ckDispose(sbQueuePath)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jsonBrokerProps)


    ProcedureReturn
EndProcedure