Receive a String from a Socket

See more Socket/SSL/TLS Examples

Demonstrates Socket.ReceiveString, which receives text and decodes it using StringCharset. It returns the first nonempty decoded result rather than draining all available data.

-- 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
    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'
    --  Send a request using a simple application-defined text protocol in which each message ends with a
    --  CRLF.
    DECLARE @command nvarchar(4000)
    SELECT @command = 'STATUS' + CHAR(13) + CHAR(10)
    EXEC sp_OAMethod @socket, 'SendString', @success OUT, @command
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @socket, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

    --  Receive text and decode it using StringCharset.  ReceiveString returns the first nonempty decoded
    --  result; it does not keep reading to drain all available data.
    DECLARE @responseText nvarchar(4000)
    EXEC sp_OAMethod @socket, 'ReceiveString', @responseText OUT
    EXEC sp_OAGetProperty @socket, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @socket, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

    PRINT @responseText

    EXEC @hr = sp_OADestroy @socket


END
GO