Qore WebSocketClient Module Reference
1.0
|
the main websocket client class More...
Public Member Functions | |
hash | connect (*hash opts, *reference info) |
connects to the websocket server More... | |
constructor (code callback, hash opts) | |
creates the object and optionally sets logging targets More... | |
disconnect (int cmd=WSCC_GoingAway) | |
disconnect with the given close code | |
bool | isOpen () |
returns True if the connection is currently open and active, False if not | |
the main websocket client class
To use this class, create a WebSocketClient object and the call WebSocketClient::connect().
The WebSocketClient::connect() method starts a background thread to receive messages, which are then posted to the callback provided in the WebSocketClient::connect() method call.
To stop listening for web socket events, call WebSocketClient::disconnect().
connects to the websocket server
This method starts a background thread to receive messages, which are then posted to the callback closure or call reference given as an argument. If the server disconnects the web socket connection, the callback will be called with no argument (ie NOTHING). In this case the event thread also terminates and the WebSocketClient object will be in a disconnected state.
To stop listening for web socket events, call WebSocketClient::disconnect().
If this method is called while a connection is already in progress, then the existing connection is first implicitly disconnected with close code WSCC_GoingAway.
opts | a hash with the following keys:
|
info | a reference to a hash which will be set to information about the call setup |
WEBSOCKET-ERROR | the option hash is missing either the 'url' or 'callback' keys or type error in the option hash |
WebSocketClient::WebSocketClient::constructor | ( | code | callback, |
hash | opts | ||
) |
creates the object and optionally sets logging targets
callback | the callhack closure or call reference for received messages |
opts | an option hash for the Qore::HTTPClient class plus the following keys:
|
WEBSOCKET-ERROR | unknown scheme, missing 'url' key in option hash |