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) Wait for Async Method to Complete

Demonstrates using the Wait method to wait for an asynchronous method to complete. This example will do an SFTP upload (over SSH) and will use the Async version of each method. Obviously, waiting for the async method to complete is the same as making a synchronous call, but an application wouldn't typically do this. An application might, for example, do other things as a background task is running, and then later wait for the task to complete.

Chilkat PureBasic Module Download

Chilkat PureBasic Module

IncludeFile "CkTask.pb"
IncludeFile "CkGlobal.pb"
IncludeFile "CkSFtp.pb"

Procedure ChilkatExample()

    ; All Chilkat classes can be unlocked at once at the beginning of a program
    ; by calling UnlockBundle.  It requires a Bundle unlock code.
    chilkatGlob.i = CkGlobal::ckCreate()
    If chilkatGlob.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkGlobal::ckUnlockBundle(chilkatGlob,"Anything for 30-day trial.")
    If success <> 1
        Debug CkGlobal::ckLastErrorText(chilkatGlob)
        CkGlobal::ckDispose(chilkatGlob)
        ProcedureReturn
    EndIf

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

    ; Set some timeouts, in milliseconds:
    CkSFtp::setCkConnectTimeoutMs(sftp, 15000)
    CkSFtp::setCkIdleTimeoutMs(sftp, 15000)
    waitMaxMs.i = 30000

    ; Connect to the SSH server.  
    ; The standard SSH port = 22
    ; The hostname may be a hostname or IP address.
    port.i = 22
    hostname.s = "www.my-ssh-server.com"

    task.i = CkSFtp::ckConnectAsync(sftp,hostname,port)
    If CkSFtp::ckLastMethodSuccess(sftp) = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkGlobal::ckDispose(chilkatGlob)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ; Start the background task.
    success = CkTask::ckRun(task)
    If Not success
        Debug CkTask::ckLastErrorText(task)
    EndIf

    ; Wait for the connect task to finish.
    ; The 1/0 returned by Wait applies to the Wait method call, not the task.
    success = CkTask::ckWait(task,waitMaxMs)
    If Not success OR (CkTask::ckStatusInt(task) <> 7) OR (CkTask::ckTaskSuccess(task) <> 1)
        If Not success
            ; The task.LastErrorText applies to the Wait method call.
            Debug CkTask::ckLastErrorText(task)
        Else
            ; The ResultErrorText applies to the underlying task method call (i.e. the Connect)
            Debug CkTask::ckStatus(task)
            Debug CkTask::ckResultErrorText(task)
        EndIf

        CkTask::ckDispose(task)

        CkGlobal::ckDispose(chilkatGlob)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    CkTask::ckDispose(task)

    ; Authenticate with the SSH server.  Chilkat SFTP supports
    ; both password-based authenication as well as public-key
    ; authentication.  This example uses password authenication.
    task = CkSFtp::ckAuthenticatePwAsync(sftp,"myLogin","myPassword")
    ; To keep the example short, we'll skip handling failures.
    ; The failures would be handled in the same way as shown above.

    success = CkTask::ckRun(task)
    success = CkTask::ckWait(task,waitMaxMs)
    CkTask::ckDispose(task)

    ; After authenticating, the SFTP subsystem must be initialized:
    task = CkSFtp::ckInitializeSftpAsync(sftp)
    success = CkTask::ckRun(task)
    success = CkTask::ckWait(task,waitMaxMs)
    CkTask::ckDispose(task)

    ; Upload from the local file to the SSH server.
    ; Important -- the remote filepath is the 1st argument,
    ; the local filepath is the 2nd argument;
    remoteFilePath.s = "hamlet.xml"
    localFilePath.s = "c:/temp/hamlet.xml"

    task = CkSFtp::ckUploadFileByNameAsync(sftp,remoteFilePath,localFilePath)
    If CkSFtp::ckLastMethodSuccess(sftp) = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkGlobal::ckDispose(chilkatGlob)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    success = CkTask::ckRun(task)
    success = CkTask::ckWait(task,waitMaxMs)
    If Not success OR (CkTask::ckStatusInt(task) <> 7) OR (CkTask::ckTaskSuccess(task) <> 1)
        If Not success
            ; The task.LastErrorText applies to the Wait method call.
            Debug CkTask::ckLastErrorText(task)
        Else
            ; The ResultErrorText applies to the underlying task method call (i.e. the Connect)
            Debug CkTask::ckStatus(task)
            Debug CkTask::ckResultErrorText(task)
        EndIf

        CkTask::ckDispose(task)

        CkGlobal::ckDispose(chilkatGlob)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    CkTask::ckDispose(task)

    Debug "File uploaded."


    CkGlobal::ckDispose(chilkatGlob)
    CkSFtp::ckDispose(sftp)


    ProcedureReturn
EndProcedure

 

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