(PowerBuilder) REST Asynchronous Streaming Upload File

See more REST Examples

Demonstrates how to asynchronous streaming upload a file to cloud storage. This particular example demonstrates an upload to the Azure Cloud Storage service. The same concepts apply to S3, Google Cloud, and Google Drive.

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

integer li_rc
oleobject loo_Rest
integer li_BTls
integer li_Port
integer li_BAutoReconnect
integer li_Success
oleobject loo_AzAuth
oleobject loo_SendStream
oleobject loo_Task
integer li_CurPctDone
integer li_ResponseStatusCode
string ls_ResponseBodyStr

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loo_Rest = create oleobject
// Use "Chilkat_9_5_0.Rest" for versions of Chilkat < 10.0.0
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Connect to the Azure Storage Blob Service
li_BTls = 1
li_Port = 443
li_BAutoReconnect = 1
// In this example, the storage account name is "chilkat".
li_Success = loo_Rest.Connect("chilkat.blob.core.windows.net",li_Port,li_BTls,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    return
end if

// Provide Azure Cloud credentials for the REST call.
loo_AzAuth = create oleobject
// Use "Chilkat_9_5_0.AuthAzureStorage" for versions of Chilkat < 10.0.0
li_rc = loo_AzAuth.ConnectToNewObject("Chilkat.AuthAzureStorage")

loo_AzAuth.AccessKey = "AZURE_ACCESS_KEY"
// The account name used here should match the 1st part of the domain passed in the call to Connect (above).
loo_AzAuth.Account = "chilkat"
loo_AzAuth.Scheme = "SharedKey"
loo_AzAuth.Service = "Blob"
// This causes the "x-ms-version: 2021-08-06" header to be automatically added.
loo_AzAuth.XMsVersion = "2021-08-06"
li_Success = loo_Rest.SetAuthAzureStorage(loo_AzAuth)

// Set some request headers.
li_Success = loo_Rest.AddHeader("x-ms-blob-content-disposition","attachment; filename=~"thisIsATest.txt~"")
li_Success = loo_Rest.AddHeader("x-ms-blob-type","BlockBlob")
li_Success = loo_Rest.AddHeader("x-ms-meta-m1","v1")
li_Success = loo_Rest.AddHeader("x-ms-meta-m2","v2")

// Note: The application does not need to explicitly set the following
// headers: x-ms-date, Authorization, and Content-Length.  These headers
// are automatically set by Chilkat.

loo_SendStream = create oleobject
// Use "Chilkat_9_5_0.Stream" for versions of Chilkat < 10.0.0
li_rc = loo_SendStream.ConnectToNewObject("Chilkat.Stream")

// Define the source data for the stream to be a file.
loo_SendStream.SourceFile = "qa_data/hamlet.xml"

// Create a background thread task to upload from the stream
// The name of the Azure storage container is "test".
loo_Task = loo_Rest.FullRequestStreamAsync("PUT","/test/thisIsATest.txt",loo_SendStream)

// Start the task. 
li_Success = loo_Task.Run()

// In this example, we'll simply sleep and periodically
// check to see if the REST upload if finished.
li_CurPctDone = 0
do while loo_Task.Finished <> 1
    loo_Task.SleepMs(100)
loop

// Check to see if the call to FullRequestStream in the background thread pool succeeded.
if loo_Task.TaskSuccess <> 1 then
    // Show what would've been the LastErrorText had FullRequestStream been called synchronously
    Write-Debug loo_Task.ResultErrorText
    destroy loo_Task
    destroy loo_Rest
    destroy loo_AzAuth
    destroy loo_SendStream
    return
end if

li_ResponseStatusCode = loo_Rest.ResponseStatusCode

// When successful, the Azure Storage service will respond with a 201 response code,
// with an empty body.  Therefore, in the success condition, the responseStr is empty.
if li_ResponseStatusCode = 201 then
    Write-Debug "File uploaded."
else
    // It failed, so examine the response body, if one was returned:
    // Given that FullRequestStream returns a string, the return value is obtained via GetResultString.
    ls_ResponseBodyStr = loo_Task.GetResultString()
    Write-Debug "response body (if any): " + ls_ResponseBodyStr

    // Examine the request/response to see what happened.
    Write-Debug "response status code = " + string(loo_Rest.ResponseStatusCode)
    Write-Debug "response status text = " + loo_Rest.ResponseStatusText
    Write-Debug "response header: " + loo_Rest.ResponseHeader
    Write-Debug "---"
    Write-Debug "LastRequestStartLine: " + loo_Rest.LastRequestStartLine
    Write-Debug "LastRequestHeader: " + loo_Rest.LastRequestHeader
end if

destroy loo_Task


destroy loo_Rest
destroy loo_AzAuth
destroy loo_SendStream