Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

MFC Examples

Web API Categories

ASN.1
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
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
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
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(MFC) Async TaskCompleted Callback

Demonstrates the use of the TaskCompleted callback for async method calls (i.e. for Chilkat asynchronous methods where the method name ends with "Async").

NOTE: This is very important: The TaskCompleted callback runs in the background thread. (All callbacks from an async task, such as AbortCheck, PercentDone, ProgressInfo, etc. are in the background thread.) An application that uses TaskCompleted must be very careful. For example, user interface elements (such as labels, text boxes, etc.) may not be directly accessible from a background thread, and could crash the application if directly accessed. Also, attempting to debug code running in a background thread from an IDE is likely to crash the IDE.

Chilkat C/C++ Library Downloads

MS Visual C/C++ Libs

See Also: Using MFC CString in Chilkat

#include <CkHttpResponse.h>
#include <CkXml.h>
#include <CkHttp.h>
#include <CkHttpRequest.h>
#include <CkTask.h>

#include <CkHttpProgress.h>

class httpProgress : public CkHttpProgress {

  public:
  httpProgress() { }
  virtual ~httpProgress() { }

  void TaskCompleted(CkTask &completedTask) {
    // A finished task could be one that was canceled, aborted, or truly finished.  

    // If the task was "canceled", it was canceled prior to actually starting.  This could
    // happen if the task was canceled while waiting in a thread pool queue to be scheduled by Chilkat's
    // background thread pool scheduler.  

    // If the task was "aborted", it indicates that it was canceled while running in a background thread.  
    // The ResultErrorText will likely indicate that the task was aborted.

    // If the task "completed", then it ran to completion, but the actual success/failure of the method
    // is determined by the result obtained via a GetResult* method.  (A "completed" task will
    // have a StatusInt equal to 7.   If the task finished, but was not completed, then it must've
    // been aborted or canceled:
    if (completedTask.get_StatusInt() != 7) {
        strOut.append("Task did not complete.");
        strOut.append("\r\n");
        strOut.append("task status: ");
        strOut.append(completedTask.status());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // The synchronous call to QuickGetObj would return an HTTP response object.  To get this 
    // response object for the async call, we instantiate a new/empty HTTP response object,
    // and then load it from the completed task.
    CkHttpResponse resp;

    bool success = resp.LoadTaskResult(completedTask);
    if (success != true) {
        strOut.append(resp.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // Now that we have the response, we can get all of the information:

    strOut.append("status code: ");
    strOut.appendInt(resp.get_StatusCode());
    strOut.append("\r\n");
    strOut.append("response header: ");
    strOut.append(resp.header());
    strOut.append("\r\n");

    CkXml xmlResponse;
    xmlResponse.LoadXml(resp.bodyStr());
    strOut.append(xmlResponse.getXml());
    strOut.append("\r\n");
  }

};

void ChilkatSample(void)
    {
    CkString strOut;

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

    CkHttp http;
    httpProgress http_progress;
    http.put_EventCallbackObject(&http_progress);

    bool success;

    CkXml soapXml;

    soapXml.put_Tag("soap12:Envelope");
    success = soapXml.AddAttribute("xmlns:xsi","http://www.w3.org/2001/XMLSchema-instance");
    success = soapXml.AddAttribute("xmlns:xsd","http://www.w3.org/2001/XMLSchema");
    success = soapXml.AddAttribute("xmlns:soap12","http://www.w3.org/2003/05/soap-envelope");

    soapXml.NewChild2("soap12:Body","");
    success = soapXml.GetChild2(0);
    soapXml.NewChild2("GetCityWeatherByZIP","");
    success = soapXml.GetChild2(0);
    success = soapXml.AddAttribute("xmlns","http://ws.cdyne.com/WeatherWS/");
    soapXml.NewChild2("ZIP","60187");
    soapXml.GetRoot2();

    strOut.append(soapXml.getXml());
    strOut.append("\r\n");

    CkHttpRequest req;
    req.put_HttpVerb("POST");
    req.put_SendCharset(false);
    req.AddHeader("Content-Type","application/soap+xml; charset=utf-8");
    req.AddHeader("SOAPAction","http://ws.cdyne.com/WeatherWS/GetCityWeatherByZIP");
    req.put_Path("/WeatherWS/Weather.asmx");
    success = req.LoadBodyFromString(soapXml.getXml(),"utf-8");

    http.put_FollowRedirects(true);

    // The name of "SynchronousRequestAsync" method is somewhat confusing. This is explained here:

    // Any Chilkat method that utilizes callbacks will have an Async version of the method.
    // The name of the Async method is the method name appended with "Async".  For example,
    // if the method is named "Abc", then the async method is "AbcAsync".
    // The Async method always returns a Chilkat Task object.

    // In the years prior to Chilkat introducing the Async functionality, this particular method's
    // name was already "SynchronousRequest".  The async versionof the method is therefore
    // "SynchronousRequestAsync" (just like "Abc" --> "AbcAsync").  Yes, it's confusing and we apologize.. 
    CkTask *task = http.SynchronousRequestAsync("wsf.cdyne.com",80,false,req);
    if (http.get_LastMethodSuccess() != true) {
        strOut.append(http.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // Schedule the task for running on the thread pool.  This changes the task's state
    // from Inert to Live.
    success = task->Run();
    if (success != true) {
        strOut.append(task->lastErrorText());
        strOut.append("\r\n");
        delete task;
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // The application is now free to do anything else
    // while the HTTP request is in progress.  When the task
    // is completed, the TaskCompleted method is called.
    delete task;

    // -------------------------------------------------------------------------------
    // The following is a general note that applies to all programming languages:
    // -------------------------------------------------------------------------------

    // NOTE: This is very important:  The TaskCompleted callback runs in the background thread.  
    // (All callbacks from an async task, such as AbortCheck, PercentDone, ProgressInfo, etc. are in the background thread.) 
    // An application that uses TaskCompleted must be very careful.  
    // For example, user interface elements (such as labels, text boxes, etc.) may not be directly
    // accessible from a background thread, and could crash the application if directly accessed.  Also, attempting to debug
    // code running in a background thread from an IDE, especially an older IDE (such as VB6) is likely to crash the IDE.


    SetDlgItemText(IDC_EDIT1,strOut.getUnicode());

    }

 

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