(Node.js) Understanding Async Function Return Values

See more Async Examples

Explains how to get the return value of the function called synchonously in the background thread.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // Some Chilkat functions can be called asynchronously.
    // If a function "Func" can be called asynchronously, there will be a corresponding "FuncAsync" function that returns a Task object.
    // 
    // When Task.Run is called, the synchronous "Func" runs in a background thread.
    // 

    // For Chilkat methods that return a status (true/false), get returned value by calling GetResultBool.
    // For example..

    var sock = new chilkat.Socket();

    // --------------------------------------------------------------
    // Synchronous call returning true/false
    var success = sock.Connect("example.com",443,true,5000);

    // --------------------------------------------------------------
    // Asynchronous call
    // task: Task
    var task = sock.ConnectAsync("example.com",443,true,5000);
    // ...
    task.Run();
    // ...
    // ...
    // Get the status (true/false) value returned by the synchronous method called in the background thread.
    success = task.GetResultBool();

    // --------------------------------------------------------------
    // Synchronous call returning an integer
    var count = sock.ReceiveCount();

    // --------------------------------------------------------------
    // Asynchronous call
    task = sock.ReceiveCountAsync();
    // ...
    task.Run();
    // ...
    // ...
    // Get the integer value returned by the synchronous method called in the background thread.
    count = task.GetResultInt();

    // --------------------------------------------------------------
    // Synchronous call returning an string
    var s = sock.ReceiveString();

    // --------------------------------------------------------------
    // Asynchronous call
    task = sock.ReceiveStringAsync();
    // ...
    task.Run();
    // ...
    // ...
    // Get the string value returned by the synchronous method called in the background thread.
    s = task.GetResultString();

    // --------------------------------------------------------------
    // Synchronous call returning an object
    // connection: Socket
    var connection = sock.AcceptNextConnection(5000);

    // --------------------------------------------------------------
    // Asynchronous call
    task = sock.AcceptNextConnectionAsync();
    // ...
    task.Run();
    // ...
    // ...
    // Get the object returned by the synchronous method called in the background thread.
    // We do this a little differently.  We create an new object of the same type,
    // and then load it with the returned object (assuming it was not null).
    var acceptedConnection = new chilkat.Socket();
    if (task.TaskSuccess == true) {
        success = acceptedConnection.LoadTaskResult(task);
    }


}

chilkatExample();