SQL Server

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 = _TRUE_. 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.

SQL Server

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

    -- This example assumes the Chilkat Socket API to have been previously unlocked.
    -- See Socket Unlock Sample for sample code.

    DECLARE @socket int
    EXEC @hr = sp_OACreate 'Chilkat.Socket', @socket OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Enable session logging:
    EXEC sp_OASetProperty @socket, 'KeepSessionLog', 1
    EXEC sp_OASetProperty @socket, 'SessionLogEncoding', 'esc'

    DECLARE @tls int
    SELECT @tls = 1
    DECLARE @maxWaitMillisec int
    SELECT @maxWaitMillisec = 20000
    EXEC sp_OAMethod @socket, 'Connect', @success OUT, 'www.chilkatsoft.com', 443, @tls, @maxWaitMillisec
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @socket, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

    -- Send a GET start line to the web server..
    EXEC sp_OAMethod @socket, 'SendString', @success OUT, 'GET /abc123.abc123 HTTP/1.1' + CHAR(13) + CHAR(10)
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @socket, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

    -- Send some bytes that will cause an error...
    DECLARE @binData int
    EXEC @hr = sp_OACreate 'Chilkat.BinData', @binData OUT

    EXEC sp_OAMethod @binData, 'AppendEncoded', @success OUT, '01020304', 'hex'
    EXEC sp_OAMethod @socket, 'SendBd', @success OUT, @binData

    -- Read the response up to the first double CRLF:
    DECLARE @httpHeader nvarchar(4000)
    EXEC sp_OAMethod @socket, 'ReceiveUntilMatch', @httpHeader OUT, CHAR(13) + CHAR(10) + CHAR(13) + CHAR(10)
    EXEC sp_OAGetProperty @socket, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @socket, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @socket
        EXEC @hr = sp_OADestroy @binData
        RETURN
      END

    -- Close the connection with the server
    -- Wait a max of 20 seconds (20000 millsec)
    EXEC sp_OAMethod @socket, 'Close', @success OUT, 20000

    -- Display the session log:
    EXEC sp_OAGetProperty @socket, 'SessionLog', @sTmp0 OUT
    PRINT @sTmp0

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

    EXEC @hr = sp_OADestroy @socket
    EXEC @hr = sp_OADestroy @binData


END
GO