Swift

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. Swift

func chilkatTest() {
    var success: Bool = false

    // 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..

    let sock = CkoSocket()!

    // --------------------------------------------------------------
    // Synchronous call returning true/false
    success = sock.connect(hostname: "example.com", port: 443, ssl: true, maxWaitMs: 5000)

    // --------------------------------------------------------------
    // Asynchronous call
    var task: CkoTask? = sock.connectAsync(hostname: "example.com", port: 443, ssl: true, maxWaitMs: 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: Int = sock.receiveCount().intValue

    // --------------------------------------------------------------
    // Asynchronous call
    task = sock.receiveCountAsync()
    // ...
    task!.run()
    // ...
    // ...
    // Get the integer value returned by the synchronous method called in the background thread.
    count = task!.getResultInt().intValue

    // --------------------------------------------------------------
    // Synchronous call returning an string
    var s: String? = 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
    var connection: CkoSocket? = sock.acceptNextConnection(maxWaitMs: 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).
    let acceptedConnection = CkoSocket()!
    if task!.taskSuccess == true {
        success = acceptedConnection.loadTaskResult(task: task)
    }


}