Chilkat HOME .NET Core C# Android™ AutoIt C C# C++ Chilkat2-Python CkPython Classic ASP DataFlex Delphi ActiveX Delphi DLL Go Java Lianja Mono C# Node.js Objective-C PHP ActiveX PHP Extension Perl PowerBuilder PowerShell PureBasic Ruby SQL Server Swift 2 Swift 3,4,5... Tcl Unicode C Unicode C++ VB.NET VBScript Visual Basic 6.0 Visual FoxPro Xojo Plugin
(Unicode C) Async SFTP Progress InfoDemonstrates checking for progress info updates when running a task asynchronously. This example demonstrates an SFTP download.
#include <C_CkGlobalW.h> #include <C_CkSFtpW.h> #include <C_CkTaskW.h> void ChilkatSample(void) { HCkGlobalW chilkatGlob; BOOL success; HCkSFtpW sftp; const wchar_t *hostname; int port; const wchar_t *localFilePath; const wchar_t *remoteFilePath; HCkTaskW task; int curPctDone; const wchar_t *name; const wchar_t *value; // All Chilkat classes can be unlocked at once at the beginning of a program // by calling UnlockBundle. It requires a Bundle unlock code. chilkatGlob = CkGlobalW_Create(); success = CkGlobalW_UnlockBundle(chilkatGlob,L"Anything for 30-day trial."); if (success != TRUE) { wprintf(L"%s\n",CkGlobalW_lastErrorText(chilkatGlob)); CkGlobalW_Dispose(chilkatGlob); return; } sftp = CkSFtpW_Create(); // Set some timeouts, in milliseconds: CkSFtpW_putConnectTimeoutMs(sftp,15000); CkSFtpW_putIdleTimeoutMs(sftp,15000); // Connect to the SSH server. // The standard SSH port = 22 // The hostname may be a hostname or IP address. hostname = L"www.my-ssh-server.com"; port = 22; success = CkSFtpW_Connect(sftp,hostname,port); if (success != TRUE) { wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp)); CkGlobalW_Dispose(chilkatGlob); CkSFtpW_Dispose(sftp); return; } // Authenticate with the SSH server. Chilkat SFTP supports // both password-based authenication as well as public-key // authentication. This example uses password authenication. success = CkSFtpW_AuthenticatePw(sftp,L"myLogin",L"myPassword"); if (success != TRUE) { wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp)); CkGlobalW_Dispose(chilkatGlob); CkSFtpW_Dispose(sftp); return; } // After authenticating, the SFTP subsystem must be initialized: success = CkSFtpW_InitializeSftp(sftp); if (success != TRUE) { wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp)); CkGlobalW_Dispose(chilkatGlob); CkSFtpW_Dispose(sftp); return; } // -------------------- // Download a file // -------------------- localFilePath = L"c:/temp/hamlet.xml"; remoteFilePath = L"subdir1/subdir2/hamlet.xml"; // Call the async version of the DownloadFileByName method to return a task object. // The task object is loaded, but is in the Inert state -- meaning it is // not yet scheduled to run on Chilkat's background thread pool. task = CkSFtpW_DownloadFileByNameAsync(sftp,remoteFilePath,localFilePath); if (CkSFtpW_getLastMethodSuccess(sftp) == FALSE) { wprintf(L"%s\n",CkSFtpW_lastErrorText(sftp)); CkGlobalW_Dispose(chilkatGlob); CkSFtpW_Dispose(sftp); return; } // Before starting the task, tell it to keep an in-memory log of what would've been // ProgressInfo callbacks. CkTaskW_putKeepProgressLog(task,TRUE); // Schedule the task for running on the thread pool. This changes the task's state // from Inert to Live. success = CkTaskW_Run(task); if (success != TRUE) { wprintf(L"%s\n",CkTaskW_lastErrorText(task)); CkTaskW_Dispose(task); CkGlobalW_Dispose(chilkatGlob); CkSFtpW_Dispose(sftp); return; } // The application is now free to do anything else // while the file is being downloaded. // For this example, we'll simply sleep and periodically // check to see if the download is finished, and report the progress // along the way. curPctDone = 0; while (CkTaskW_getFinished(task) != TRUE) { if (CkTaskW_getPercentDone(task) != curPctDone) { curPctDone = CkTaskW_getPercentDone(task); wprintf(L"%d percent done\n",curPctDone); } // Check the progress info log. // Emit any log entries.. while ((CkTaskW_getProgressLogSize(task) > 0)) { // Get the 1st entry, emit it, and then remove it.. name = CkTaskW_progressInfoName(task,0); value = CkTaskW_progressInfoValue(task,0); // Entries reporting the received byte count will have the name "RcvByteCount" // Entries reporting the current bytes-per-second will have the name "RcvBytesPerSec" wprintf(L"%s: %s\n",name,value); CkTaskW_RemoveProgressInfo(task,0); } // Sleep 100 ms. CkTaskW_SleepMs(task,100); } // Just in case there are any remaining entries... while ((CkTaskW_getProgressLogSize(task) > 0)) { // Get the 1st entry, emit it, and then remove it.. name = CkTaskW_progressInfoName(task,0); value = CkTaskW_progressInfoValue(task,0); wprintf(L"%s: %s\n",name,value); CkTaskW_RemoveProgressInfo(task,0); } // 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 (CkTaskW_getStatusInt(task) != 7) { wprintf(L"Task did not complete.\n"); wprintf(L"task status: %s\n",CkTaskW_status(task)); CkTaskW_Dispose(task); CkGlobalW_Dispose(chilkatGlob); CkSFtpW_Dispose(sftp); return; } // The DownloadFileByName method returns a boolean. Therefore, after the task is finished, // we can get the boolean result by calling GetResultBool. This is the return value had // we called DownloadFileByName synchronously. success = CkTaskW_GetResultBool(task); if (success != TRUE) { // The task's ResultErrorText contains what would have been in the LastErrorText property had // the DownloadFileByName method been called synchronously. wprintf(L"%s\n",CkTaskW_resultErrorText(task)); } else { wprintf(L"File downloaded asynchronously.\n"); } CkTaskW_Dispose(task); CkGlobalW_Dispose(chilkatGlob); CkSFtpW_Dispose(sftp); } |
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.