Close a Socket Connection

See more Socket/SSL/TLS Examples

Demonstrates Socket.Close, which gracefully terminates and closes the current TCP, TLS, or SSH channel connection. The argument bounds how long to wait for clean shutdown processing.

--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

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

    --  Connect to the server using TLS.  The 3rd argument enables the TLS handshake after the TCP
    --  connection succeeds; the 4th is the maximum time to wait, in milliseconds.
    DECLARE @bTls int
    SELECT @bTls = 1
    DECLARE @maxWaitMs int
    SELECT @maxWaitMs = 5000
    EXEC sp_OAMethod @socket, 'Connect', @success OUT, 'example.com', 5000, @bTls, @maxWaitMs
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @socket, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

    --  StringCharset controls the character encoding used when sending and receiving text.
    EXEC sp_OASetProperty @socket, 'StringCharset', 'utf-8'

    --  Gracefully close the current TCP, TLS, or SSH channel connection.  The argument is the maximum
    --  number of milliseconds to wait for clean shutdown processing (0 waits indefinitely).
    EXEC sp_OAMethod @socket, 'Close', @success OUT, 1000
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @socket, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

    PRINT 'Connection closed.'

    EXEC @hr = sp_OADestroy @socket


END
GO