(PureBasic) Asynchronous Sockets - Reading/Writing Data

Demonstrates the following using async methods:

Demonstrates receiving text on a socket connection up to and including when an expected CRLF arrives. The example sends an HTTP HEAD request to an HTTP server and then reads the response header using ReceiveToCRLF and ReceiveUntilMatch.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkSocket.pb"
IncludeFile "CkTask.pb"

Procedure ChilkatExample()

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

    socket.i = CkSocket::ckCreate()
    If socket.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect using TLS to www.chilkatsoft.com
    ; We could also use a normal TCP connection also by specifying port 80 with useTls = 0.
    useTls.i = 1
    maxWaitMillisec.i = 20000
    connectTask.i = CkSocket::ckConnectAsync(socket,"www.chilkatsoft.com",443,useTls,maxWaitMillisec)
    If CkSocket::ckLastMethodSuccess(socket) <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ; Schedule the task for running on the thread pool.  This changes the task's state
    ; from Inert to Live.
    success.i = CkTask::ckRun(connectTask)
    If success <> 1
        Debug CkTask::ckLastErrorText(connectTask)
        CkTask::ckDispose(connectTask)

        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ; The application is now free to do anything else.
    ; For programming languages where Chilkat supports events, a TaskCompleted
    ; event will fire when the task is completed.

    ; For this example, we'll simply sleep and periodically
    ; check to see when the connection is ready.
    While CkTask::ckFinished(connectTask) <> 1

        ; Sleep 10 ms.
        CkTask::ckSleepMs(connectTask,10)

    Wend

    ; 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 CkTask::ckStatusInt(connectTask) <> 7
        Debug "Task did not complete."
        Debug "task status: " + CkTask::ckStatus(connectTask)
        CkTask::ckDispose(connectTask)

        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    connectSuccess.i = CkTask::ckGetResultBool(connectTask)
    If connectSuccess <> 1
        Debug "Connect failed."
        Debug CkTask::ckResultErrorText(connectTask)
        CkTask::ckDispose(connectTask)

        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    CkTask::ckDispose(connectTask)

    ; Tell the socket object that all text is to be sent in the utf-8 encoding,
    ; and the text received is assumed to be utf-8.
    CkSocket::setCkStringCharset(socket, "utf-8")

    ; Send an HTTP HEAD request:
    sendTask.i = CkSocket::ckSendStringAsync(socket,"HEAD / HTTP/1.1" + Chr(13) + Chr(10) + "Host: www.chilkatsoft.com" + Chr(13) + Chr(10) + Chr(13) + Chr(10))
    If CkSocket::ckLastMethodSuccess(socket) <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    success = CkTask::ckRun(sendTask)
    If success <> 1
        Debug CkTask::ckLastErrorText(sendTask)
        CkTask::ckDispose(sendTask)

        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ; The application is now free to do anything else.
    ; For programming languages where Chilkat supports events, 
    ; a TaskCompleted event will fire when the task is completed.
    ; This example will simply wait until the task completes...
    While CkTask::ckFinished(sendTask) <> 1
        ; Sleep 10 ms.
        CkTask::ckSleepMs(sendTask,10)
    Wend
    If CkTask::ckStatusInt(sendTask) <> 7
        Debug "Task did not complete."
        Debug "task status: " + CkTask::ckStatus(sendTask)
        CkTask::ckDispose(sendTask)

        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    sendSuccess.i = CkTask::ckGetResultBool(sendTask)
    If sendSuccess <> 1
        Debug "Send failed."
        Debug CkTask::ckResultErrorText(sendTask)
        CkTask::ckDispose(sendTask)

        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    CkTask::ckDispose(sendTask)

    ; Wait a maximum of 4 seconds while no data is forthcoming:
    CkSocket::setCkMaxReadIdleMs(socket, 4000)

    ; To explain MaxReadIdleMs further:  In Chilkat, a max "idle timeout" is the max time to wait
    ; while no additional data arrives on the socket.  Imagine if 10MB of data will be received
    ; where the 1st CRLF occurs at the very end.  As long as the data continues arriving and does not
    ; halt for more than 4000ms, then the ReceiveToCRLF will continue receiving.  It is only after
    ; the connection becomes idle for more than 4000ms that the app will giveup and fail the read.

    ; Get the 1st response line, which should be "HTTP/1.1 200 OK"
    receiveTask.i = CkSocket::ckReceiveToCRLFAsync(socket)
    If CkSocket::ckLastMethodSuccess(socket) <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    success = CkTask::ckRun(receiveTask)
    If success <> 1
        Debug CkTask::ckLastErrorText(receiveTask)
        CkTask::ckDispose(receiveTask)

        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ; The application is now free to do anything else.
    ; For programming languages where Chilkat supports events, 
    ; a TaskCompleted event will fire when the task is completed.
    ; This example will simply wait until the task completes...
    While CkTask::ckFinished(receiveTask) <> 1
        ; Sleep 10 ms.
        CkTask::ckSleepMs(receiveTask,10)
    Wend
    If CkTask::ckStatusInt(receiveTask) <> 7
        Debug "Task did not complete."
        Debug "task status: " + CkTask::ckStatus(receiveTask)
        CkTask::ckDispose(receiveTask)

        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    responseStatusLine.s = CkTask::ckGetResultString(receiveTask)

    Debug "StatusLine: " + responseStatusLine
    CkTask::ckDispose(receiveTask)

    ; Now get the 1st line of the response header:
    responseHeaderLine.s = CkSocket::ckReceiveToCRLF(socket)
    If CkSocket::ckLastMethodSuccess(socket) <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    Debug "HeaderLine: " + responseHeaderLine

    ; Now read the remainder of the response header by reading until a double CRLF is seen:
    receiveTask = CkSocket::ckReceiveUntilMatchAsync(socket,Chr(13) + Chr(10) + Chr(13) + Chr(10))
    If CkSocket::ckLastMethodSuccess(socket) <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    success = CkTask::ckRun(receiveTask)
    If success <> 1
        Debug CkTask::ckLastErrorText(receiveTask)
        CkTask::ckDispose(receiveTask)

        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ; The application is now free to do anything else.
    ; For programming languages where Chilkat supports events, 
    ; a TaskCompleted event will fire when the task is completed.
    ; This example will simply wait until the task completes...
    While CkTask::ckFinished(receiveTask) <> 1
        ; Sleep 10 ms.
        CkTask::ckSleepMs(receiveTask,10)
    Wend
    If CkTask::ckStatusInt(receiveTask) <> 7
        Debug "Task did not complete."
        Debug "task status: " + CkTask::ckStatus(receiveTask)
        CkTask::ckDispose(receiveTask)

        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    remainderOfHeader.s = CkTask::ckGetResultString(receiveTask)

    Debug "Remainder: " + remainderOfHeader
    CkTask::ckDispose(receiveTask)

    ; Close the connection with the server
    ; Wait a max of 20 seconds (20000 millsec)
    success = CkSocket::ckClose(socket,20000)


    CkSocket::ckDispose(socket)


    ProcedureReturn
EndProcedure