Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

PureBasic Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(PureBasic) REST Asynchronous Streaming Upload Simplified

This is example is simplified in that it calls FullRequestStreamAsync instead of making calls to SendReqStreamBodyAsync, ReadResponseHeader, and ReadRespBodyStr.

It demonstrates how to create and write to a stream that feeds an asynchronous upload 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 PureBasic Module Download

Chilkat PureBasic Module

IncludeFile "CkTask.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAzureStorage.pb"
IncludeFile "CkStream.pb"

Procedure ChilkatExample()

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

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to the Azure Storage Blob Service
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    ; In this example, the storage account name is "chilkat".
    success.i = CkRest::ckConnect(rest,"chilkat.blob.core.windows.net",port,bTls,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Provide Azure Cloud credentials for the REST call.
    azAuth.i = CkAuthAzureStorage::ckCreate()
    If azAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAzureStorage::setCkAccessKey(azAuth, "AZURE_ACCESS_KEY")
    ; The account name used here should match the 1st part of the domain passed in the call to Connect (above).
    CkAuthAzureStorage::setCkAccount(azAuth, "chilkat")
    CkAuthAzureStorage::setCkScheme(azAuth, "SharedKey")
    CkAuthAzureStorage::setCkService(azAuth, "Blob")
    ; This causes the "x-ms-version: 2021-08-06" header to be automatically added.
    CkAuthAzureStorage::setCkXMsVersion(azAuth, "2021-08-06")
    success = CkRest::ckSetAuthAzureStorage(rest,azAuth)

    ; Set some request headers.
    success = CkRest::ckAddHeader(rest,"x-ms-blob-content-disposition","attachment; filename=" + Chr(34) + "thisIsATest.txt" + Chr(34))
    success = CkRest::ckAddHeader(rest,"x-ms-blob-type","BlockBlob")
    success = CkRest::ckAddHeader(rest,"x-ms-meta-m1","v1")
    success = CkRest::ckAddHeader(rest,"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.

    sendStream.i = CkStream::ckCreate()
    If sendStream.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Create a background thread task to upload from the stream
    ; The name of the Azure storage container is "test".
    ; After the background task is started and running in a background thread,
    ; the foreground thread will write 100 text lines of "this is a test\r\n" to the
    ; stream.
    uploadTask.i = CkRest::ckFullRequestStreamAsync(rest,"PUT","/test/thisIsATest.txt",sendStream)

    ; Start the task. 
    success = CkTask::ckRun(uploadTask)

    ; The application can write to the stream, and close the stream
    ; when finished.  Whatever is written to the stream uploaded to the remote file.
    i.i
    For i = 1 To 100
        success = CkStream::ckWriteString(sendStream,"This is a test" + Chr(13) + Chr(10))
        If success <> 1
            success = CkTask::ckCancel(uploadTask)
            CkTask::ckDispose(uploadTask)

            Debug "Failed to write to sendStream."
            CkRest::ckDispose(rest)
            CkAuthAzureStorage::ckDispose(azAuth)
            CkStream::ckDispose(sendStream)
            ProcedureReturn
        EndIf

    Next

    ; Close the stream to indicate no more data will be sent.
    success = CkStream::ckWriteClose(sendStream)

    ; Make sure the uploadTask has finished.
    ; It is likely that task is already finished..
    ; Wait a max of 5 seconds..
    success = CkTask::ckWait(uploadTask,5000)

    ; FullRequestStreamAsync both sent the request and received the response.
    ; Check to see if the task finished properly.
    If CkTask::ckStatusInt(uploadTask) <> 7
        Debug "Task did not end in the finished state."
        Debug "Task status: " + CkTask::ckStatus(uploadTask)
        CkTask::ckDispose(uploadTask)

        CkRest::ckDispose(rest)
        CkAuthAzureStorage::ckDispose(azAuth)
        CkStream::ckDispose(sendStream)
        ProcedureReturn
    EndIf

    ; Check to see if the call to FullRequestStream in the background thread pool succeeded.
    If CkTask::ckTaskSuccess(uploadTask) <> 1
        ; Show what would've been the LastErrorText had FullRequestStream been called synchronously
        Debug CkTask::ckResultErrorText(uploadTask)
        CkTask::ckDispose(uploadTask)

        CkRest::ckDispose(rest)
        CkAuthAzureStorage::ckDispose(azAuth)
        CkStream::ckDispose(sendStream)
        ProcedureReturn
    EndIf

    responseStatusCode.i = CkRest::ckResponseStatusCode(rest)

    ; 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 responseStatusCode = 201
        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.
        responseBodyStr.s = CkTask::ckGetResultString(uploadTask)
        Debug "response body (if any): " + responseBodyStr

        ; Examine the request/response to see what happened.
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "---"
        Debug "LastRequestStartLine: " + CkRest::ckLastRequestStartLine(rest)
        Debug "LastRequestHeader: " + CkRest::ckLastRequestHeader(rest)
    EndIf



    CkRest::ckDispose(rest)
    CkAuthAzureStorage::ckDispose(azAuth)
    CkStream::ckDispose(sendStream)


    ProcedureReturn
EndProcedure

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.