websocket_connect_async


Description:

[ Version ( since = "2.50" ) ]
public async WebsocketConnection websocket_connect_async (Message msg, string? origin, string[]? protocols, Cancellable? cancellable) throws Error

Asynchronously creates a WebsocketConnection to communicate with a remote server.

All necessary WebSocket-related headers will be added to msg, and it will then be sent and asynchronously processed normally (including handling of redirection and HTTP authentication).

If the server returns "101 Switching Protocols", then msg's status code and response headers will be updated, and then the WebSocket handshake will be completed. On success, websocket_connect_async.end will return a new WebsocketConnection. On failure it will return a Error.

If the server returns a status other than "101 Switching Protocols", then msg will contain the complete response headers and body from the server's response, and websocket_connect_async.end will return NOT_WEBSOCKET.

Parameters:

this

a Session

msg

Message indicating the WebSocket server to connect to

origin

origin of the connection

protocols

a null-terminated array of protocols supported

cancellable

a Cancellable

callback

the callback to invoke

user_data

data for callback