SQL Server

Debugging with Socket Session Logging

See more Socket/SSL/TLS Examples

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 = _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 requires the Chilkat API to have been previously unlocked.
    -- See Global 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'

    -- To demonstrate session logging, we'll connect to an
    -- HTTP server and download the HTTP response header:
    DECLARE @ssl int
    SELECT @ssl = 0
    DECLARE @maxWaitMillisec int
    SELECT @maxWaitMillisec = 20000
    EXEC sp_OAMethod @socket, 'Connect', @success OUT, 'www.chilkatsoft.com', 80, @ssl, @maxWaitMillisec
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @socket, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

    -- Set maximum timeouts for reading an writing (in millisec)
    EXEC sp_OASetProperty @socket, 'MaxReadIdleMs', 10000
    EXEC sp_OASetProperty @socket, 'MaxSendIdleMs', 10000

    -- The socket component includes a BuildHttpGetRequest
    -- method for convenience. Build a GET and send it to 
    -- the web server:
    DECLARE @httpGet nvarchar(4000)

    EXEC sp_OAMethod @socket, 'BuildHttpGetRequest', @httpGet OUT, 'http://www.chilkatsoft.com/'

    -- Send it...
    EXEC sp_OAMethod @socket, 'SendString', @success OUT, @httpGet
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @socket, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

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

    -- Show the HTTP response header:

    PRINT @httpHeader

    EXEC @hr = sp_OADestroy @socket


END
GO