(PureBasic) Debugging with Socket Session Logging

Debugging with socket session logging.

The Chilkat Socket component provides properties for keeping a session log making it possible to see the exact bytes received and sent on a TCP/IP or SSL connection. To enable session logging, set the KeepSessionLog property = 1. The SessionLogEncoding property controls how binary, non-printable bytes are represented in the log. There are two possible settings: Possible values are "esc" and "hex". The default value is "esc".

When set to "hex", the bytes are encoded as a hexidecimalized string. The "esc" encoding is a C-string like encoding, and is more compact than hex if most of the data to be logged is text. Printable us-ascii chars are unmodified. Common "C" control chars are represented as "\r", "\n", "\t", etc. Non-printable and byte values greater than 0x80 are escaped using a backslash and hex encoding: \xHH. Certain printable chars are backslashed: SPACE, double-quote, single-quote, etc.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkSocket.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

    ; Enable session logging:
    CkSocket::setCkKeepSessionLog(socket, 1)
    CkSocket::setCkSessionLogEncoding(socket, "esc")

    ; To demonstrate session logging, we'll connect to an
    ; HTTP server and download the HTTP response header:
    ssl.i = 0
    maxWaitMillisec.i = 20000
    success.i = CkSocket::ckConnect(socket,"www.chilkatsoft.com",80,ssl,maxWaitMillisec)
    If success <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ; Set maximum timeouts for reading an writing (in millisec)
    CkSocket::setCkMaxReadIdleMs(socket, 10000)
    CkSocket::setCkMaxSendIdleMs(socket, 10000)

    ; The socket component includes a BuildHttpGetRequest
    ; method for convenience. Build a GET and send it to 
    ; the web server:
    httpGet.s
    httpGet = CkSocket::ckBuildHttpGetRequest(socket,"http://www.chilkatsoft.com/")

    ; Send it...
    success = CkSocket::ckSendString(socket,httpGet)
    If success <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ; Read the response up to the first double CRLF:
    httpHeader.s = CkSocket::ckReceiveUntilMatch(socket,Chr(13) + Chr(10) + Chr(13) + Chr(10))
    If CkSocket::ckLastMethodSuccess(socket) <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

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

    ; Display the session log:
    Debug CkSocket::ckSessionLog(socket)

    ; Show the HTTP response header:
    Debug httpHeader


    CkSocket::ckDispose(socket)


    ProcedureReturn
EndProcedure