mobileFX WebSocketX
WebSocketX ActiveX DLL / WebSocket Object / Close Method
In This Topic
    Close Method
    In This Topic
    Description

    Asynchronously close WebSocket connection by transmitting a close code.

    Syntax
    Visual Basic
    Public Sub Close( _
       ByVal Code As WEBSOCKET_CLOSE_CODE_ENUM _
    ) 
    Parameters
    Code
    ValueDescription
    CLOSE_CODE_BAD_PAYLOAD

    The endpoint is terminating the connection because a message was received that contained inconsistent data (e.g., non-UTF-8 data within a text message).

    CLOSE_CODE_GOING_AWAY

    The endpoint is going away, either because of a server failure or because the browser is navigating away from the page that opened the connection.

    CLOSE_CODE_INTERNAL_ERROR

    The server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.

    CLOSE_CODE_NEEDS_EXTENSION

    The client is terminating the connection because it expected the server to negotiate one or more extension, but the server didn't.

    CLOSE_CODE_NORMAL

    Normal closure; the connection successfully completed whatever purpose for which it was created.

    CLOSE_CODE_POLICY_ERROR

    The endpoint is terminating the connection because it received a message that violates its policy. This is a generic status code, used when codes 1003 and 1009 are not suitable.

    CLOSE_CODE_PROTOCOL_ERROR

    The endpoint is terminating the connection due to a protocol error.

    CLOSE_CODE_SERVICE_RESTART

    The server is terminating the connection because it is restarting.

    CLOSE_CODE_TOO_BIG

    The endpoint is terminating the connection because a data frame was received that is too large.

    CLOSE_CODE_TRY_AGAIN_LATER

    The server is terminating the connection due to a temporary condition, e.g. it is overloaded and is casting off some of its clients.

    CLOSE_CODE_UNKNOWN_DATA

    The connection is being terminated because the endpoint received data of a type it cannot accept (for example, a text-only endpoint received binary data).

    Remarks

    Asynchronously close WebSocket connection by transmitting a close code.

    See Also