Objective-C

Async Progress Info Log

See more Async Examples

Demonstrates checking for progress info updates when running a task asynchronously. Objective-C

#import <CkoMailMan.h>
#import <CkoEmail.h>
#import <CkoTask.h>
#import <NSString.h>

BOOL success = NO;

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

success = NO;

// The mailman object is used for sending and receiving email.
CkoMailMan *mailman = [[CkoMailMan alloc] init];

// Set the SMTP server and any required settings.
mailman.SmtpHost = @"smtp.mymailserver.com";
mailman.SmtpUsername = @"myLogin";
mailman.SmtpPassword = @"myPassword";
mailman.StartTLS = YES;

// Create a new email object
CkoEmail *email = [[CkoEmail alloc] init];

email.Subject = @"This is a test";
email.Body = @"This is a test";
email.From = @"Chilkat Support <support@chilkatsoft.com>";
success = [email AddTo: @"Chilkat Admin" emailAddress: @"admin@chilkatsoft.com"];

// Call the async version of the SendEmail 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.
CkoTask *task = [mailman SendEmailAsync: email];
if (mailman.LastMethodSuccess == NO) {
    NSLog(@"%@",mailman.LastErrorText);
    return;
}

// Before starting the task, tell it to keep an in-memory log of what would've been
// ProgressInfo event callbacks.
task.KeepProgressLog = YES;

// Schedule the task for running on the thread pool.  This changes the task's state
// from Inert to Live.
success = [task Run];
if (success != YES) {
    NSLog(@"%@",task.LastErrorText);

    return;
}

// The application is now free to do anything else
// while the email is being sent.

// For this example, we'll simply sleep and periodically
// check to see if the SendEmail if finished.  While checking
// however, we'll report on the progress.
int curPctDone = 0;
NSString *name = 0;
NSString *value = 0;

while (task.Finished != YES) {

    if ([task.PercentDone intValue] != curPctDone) {
        curPctDone = [task.PercentDone intValue];
        NSLog(@"%d%@",curPctDone,@" percent done");
    }

    // Check the progress info log.
    // Emit any log entries..
    while (([task.ProgressLogSize intValue] > 0)) {
        // Get the 1st entry, emit it, and then remove it..
        name = [task ProgressInfoName: [NSNumber numberWithInt: 0]];
        value = [task ProgressInfoValue: [NSNumber numberWithInt: 0]];
        NSLog(@"%@%@%@",name,@": ",value);
        [task RemoveProgressInfo: [NSNumber numberWithInt: 0]];
    }

    // Sleep 100 ms.
    [task SleepMs: [NSNumber numberWithInt: 100]];

}

// Just in case there are any remaining entries...
while (([task.ProgressLogSize intValue] > 0)) {
    // Get the 1st entry, emit it, and then remove it..
    name = [task ProgressInfoName: [NSNumber numberWithInt: 0]];
    value = [task ProgressInfoValue: [NSNumber numberWithInt: 0]];
    NSLog(@"%@%@%@",name,@": ",value);
    [task RemoveProgressInfo: [NSNumber numberWithInt: 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 ([task.StatusInt intValue] != 7) {
    NSLog(@"%@",@"Task did not complete.");
    NSLog(@"%@%@",@"task status: ",task.Status);

    return;
}

// The SendEmail 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 SendEmail synchronously.
success = [task GetResultBool];
if (success != YES) {
    // The task's ResultErrorText contains what would have been in the LastErrorText property had
    // the SendEmail method been called synchronously.
    NSLog(@"%@",task.ResultErrorText);
}
else {
    NSLog(@"%@",@"Email sent asynchronously.");
}

success = [mailman CloseSmtpConnection];
if (success != YES) {
    NSLog(@"%@",@"Connection to SMTP server not closed cleanly.");

}