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.

IncludeFile "CkSocket.pb"

Procedure ChilkatExample()

    success.i = 0

    socket.i = CkSocket::ckCreate()
    If socket.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  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.
    bTls.i = 1
    maxWaitMs.i = 5000
    success = CkSocket::ckConnect(socket,"example.com",5000,bTls,maxWaitMs)
    If success = 0
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ;  StringCharset controls the character encoding used when sending and receiving text.
    CkSocket::setCkStringCharset(socket, "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).
    success = CkSocket::ckClose(socket,1000)
    If success = 0
        Debug CkSocket::ckLastErrorText(socket)
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    Debug "Connection closed."


    CkSocket::ckDispose(socket)


    ProcedureReturn
EndProcedure