(PHP ActiveX) 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.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

// 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 (1/0), get returned value by calling GetResultBool.
// For example..

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Socket')
$sock = new COM("Chilkat.Socket");

// --------------------------------------------------------------
// Synchronous call returning 1/0
$success = $sock->Connect('example.com',443,1,5000);

// --------------------------------------------------------------
// Asynchronous call
// task is a Chilkat.Task
$task = $sock->ConnectAsync('example.com',443,1,5000);
// ...
$task->Run();
// ...
// ...
// Get the status (1/0) value returned by the synchronous method called in the background thread.
$success = $task->GetResultBool();

// --------------------------------------------------------------
// Synchronous call returning an integer
$count = $sock->ReceiveCount();

// --------------------------------------------------------------
// Asynchronous call
// task is a Chilkat.Task
$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
$s = $sock->receiveString();

// --------------------------------------------------------------
// Asynchronous call
// task is a Chilkat.Task
$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 is a Chilkat.Socket
$connection = $sock->AcceptNextConnection(5000);

// --------------------------------------------------------------
// Asynchronous call
// task is a Chilkat.Task
$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).
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Socket')
$acceptedConnection = new COM("Chilkat.Socket");
if ($task->TaskSuccess == 1) {
    $success = $acceptedConnection->LoadTaskResult($task);
}


?>