(Visual FoxPro) Azure Service Bus - Read Queued Message

See more Azure Service Bus Examples

Demonstrates read a message from an Azure Service Bus Queue. The message is received and removed from the queue.

For more information, see https://docs.microsoft.com/en-us/rest/api/servicebus/receive-and-delete-message-destructive-read

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL lnSuccess
LOCAL lcQueueName
LOCAL loSbToken
LOCAL loSbPath
LOCAL loSbResponseBody
LOCAL lcMessage

* 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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Rest')
loRest = CreateObject('Chilkat.Rest')
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("<yournamespace>.servicebus.windows.net",443,1,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
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..
* ----------------------------------------------------------------------------------------------

* Receive and delete a message from a queue named "gila";
lcQueueName = "gila"

* 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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbToken = CreateObject('Chilkat.StringBuilder')
loSbToken.LoadFile("qa_data/tokens/serviceBusSas.txt","utf-8")

* Tell the REST object to use the Azure Shared Access Signature for authorization.
loSbToken.Prepend("SharedAccessSignature ")
loRest.AddHeader("Authorization",loSbToken.GetAsString())

* Build the path..
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbPath = CreateObject('Chilkat.StringBuilder')
loSbPath.Append("/")
loSbPath.Append(lcQueueName)
loSbPath.Append("/messages/head")

* Add timeout and api-version query parameters.
loRest.AddQueryParam("timeout","20")
loRest.AddQueryParam("api-version","2013-08")

* Use the DELETE HTTP verb to read the message at the head of the queue and remove it.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loRest.FullRequestNoBodySb("DELETE",loSbPath.GetAsString(),loSbResponseBody)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loSbToken
    RELEASE loSbPath
    RELEASE loSbResponseBody
    CANCEL
ENDIF

? "Response Status Code = " + STR(loRest.ResponseStatusCode)

* Check for a success response.
IF (loRest.ResponseStatusCode <> 200) THEN
    ? loRest.LastRequestStartLine
    ? loRest.LastRequestHeader
    ? loSbResponseBody.GetAsString()
    ? "Failed."
    RELEASE loRest
    RELEASE loSbToken
    RELEASE loSbPath
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* If successful, the message is the contents of the response body.
lcMessage = loSbResponseBody.GetAsString()
? "Dequeued message: " + lcMessage

? "Success."

RELEASE loRest
RELEASE loSbToken
RELEASE loSbPath
RELEASE loSbResponseBody