(PureBasic) Demonstrates KeepSessionLog and SessionLog

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/TLS 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 "CkBinData.pb"
IncludeFile "CkSocket.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat Socket API to have been previously unlocked.
    ; See Socket 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")

    tls.i = 1
    maxWaitMillisec.i = 20000
    success.i = CkSocket::ckConnect(socket,"www.chilkatsoft.com",443,tls,maxWaitMillisec)
    If success <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ; Send a GET start line to the web server..
    success = CkSocket::ckSendString(socket,"GET /abc123.abc123 HTTP/1.1" + Chr(13) + Chr(10))
    If success <> 1
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ; Send some bytes that will cause an error...
    binData.i = CkBinData::ckCreate()
    If binData.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkBinData::ckAppendEncoded(binData,"01020304","hex")
    success = CkSocket::ckSendBd(socket,binData)

    ; 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)
        CkBinData::ckDispose(binData)
        ProcedureReturn
    EndIf

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

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

    ; The Session log will show the exact bytes sent and received.
    ; In this case, the session log shows:

    ; 	SendString: GET\x20/abc123.abc123\x20HTTP/1.1\r\n
    ; 		
    ; 	SendBytes: \x01\x02\x03\x04
    ; 	ReceiveUntilMatch: HTTP/1.1\x20400\x20Bad\x20Request\r\n
    ; 		Content-Type:\x20text/html;\x20charset=us-ascii\r\n
    ; 		Server:\x20Microsoft-HTTPAPI/2.0\r\n
    ; 		Date:\x20Thu,\x2027\x20Oct\x202016\x2013:16:02\x20GMT\r\n
    ; 		Connection:\x20close\r\n
    ; 		Content-Length:\x20339\r\n
    ; 		\r\n
    ; 		<!DOCTYPE\x20HTML\x20PUBLIC\x20\"-//W3C//DTD\x20HTML\x204.01//EN\"\"http://www.w
    ; 		3.org/TR/html4/strict.dtd\">\r\n
    ; 		<HTML><HEAD><TITLE>Bad\x20Request</TITLE>\r\n
    ; 		<META\x20HTTP-EQUIV=\"Content-Type\"\x20Content=\"text/html;\x20charset=us-ascii
    ; 		\"></HEAD>\r\n
    ; 		<BODY><h2>Bad\x20Request\x20-\x20Invalid\x20Header</h2>\r\n
    ; 		<hr><p>HTTP\x20Error\x20400.\x20The\x20request\x20has\x20an\x20invalid\x20header
    ; 		\x20name.</p>\r\n
    ; 		</BODY></HTML>\r\n
    ; 


    CkSocket::ckDispose(socket)
    CkBinData::ckDispose(binData)


    ProcedureReturn
EndProcedure