(PureBasic) Cancel HTTP Get Async Task if not Completed after a Max Time

Demonstrates how to wait a maximum amount of time for an asynchronous task to completed. If not completed in the allotted amount of time, the task is cancelled.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkTask.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    success.i
    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Set some timeouts, in seconds:
    CkHttp::setCkConnectTimeout(http, 15)
    ; ReadTimeout specifies the max number of seconds that must elapse when no additional data is received before
    ; timing out.  For example, if a server sends a 300 byte response at the rate of 1 byte per second, then
    ; ReadTimeout would never cause a timeout because there is never a 15 second interval when nothing arrives.
    CkHttp::setCkReadTimeout(http, 15)

    url.s = "https://your-url.com/something"
    task.i = CkHttp::ckQuickGetStrAsync(http,url)
    CkTask::ckRun(task)

    ; Wait a maximum of waitMaxMs for the task (i.e. the HTTP GET) to complete.
    ; The Wait method returns when the task has been canceled, aborted, or completed, or when the max allotted time has passed.
    waitMaxMs.i = 20000
    CkTask::ckWait(task,waitMaxMs)

    ; At this point, the GET may or may not have completed.  
    ; Rather than checking the Task status, we can call task.Cancel because
    ; if the Task is no longer running (because it already completed, was canceled or aborted), then the 
    ; call to Cancel is a NO-OP (meaning it does nothing and the Task's status is unaffected).
    ; Also, task.Cancel returns 1 if the task was in the "queued" or "running" state and was canceled or aborted. 
    ; The method returns 0 if the task has any other status.
    wasCanceled.i = CkTask::ckCancel(task)
    If wasCanceled = 1
        Debug "The HTTP GET took too long and was canceled."
    Else
        ; Find out what happened.
        If CkTask::ckStatusInt(task) = 7
            ; The task completed, which means the background thread's call to QuickGetStr completed
            ; with success or failure.  Find out which...
            If CkTask::ckTaskSuccess(task) = 1
                ; Get the string response for the call to QuickGetStr (which happened in Chilkat's background thread).
                responseStr.s = CkTask::ckGetResultString(task)
                Debug responseStr
                Debug "HTTP GET successful!"
            Else
                Debug "HTTP GET failed prior to waitMaxMs..."
                Debug CkTask::ckResultErrorText(task)
            EndIf

        Else
            ; The task must've been canceled or aborted by some other means..
            Debug "Task did not complete.  Final status: " + CkTask::ckStatus(task)
        EndIf

    EndIf

    CkTask::ckDispose(task)



    CkHttp::ckDispose(http)


    ProcedureReturn
EndProcedure