$darkmode
class for websocket connections; returns an object of class WebSocketClient for receiving websocket events from a websocket server More...
Inherits ConnectionProvider::AbstractConnectionWithInfo.
Public Member Functions | |
| constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={}) | |
| creates the WebSocketConnectionObject connection object More... | |
| DataProvider::AbstractDataProvider | getDataProvider () |
| returns an WebSocketClientDataProvider object for this connection More... | |
| *hash< auto > | getRuntimeOptions () |
| returns runtime options More... | |
| string | getType () |
returns "ws" | |
| bool | hasDataProvider () |
| returns True, as the connection returns a data provider with the getDataProvider() method More... | |
Public Attributes | |
| const | ConnectionScheme |
| Connection entry info. | |
Protected Member Functions | |
| hash< ConnectionSchemeInfo > | getConnectionSchemeInfoImpl () |
| Returns the ConnectionSchemeInfo hash for this object. | |
| WebSocketClient | getImpl (bool connect=True, *hash< auto > rtopts) |
| returns a WebSocketClient object More... | |
| setChildCapabilities () | |
| Sets child data provider capabilities. | |
class for websocket connections; returns an object of class WebSocketClient for receiving websocket events from a websocket server
supports the following options:
"connect_timeout": connection timeout to use in milliseconds"http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")"max_redirects": maximum redirects to support"proxy": proxy URL to use"timeout": transfer timeout to use in millisecondsalso supports the following runtime options in getImpl():
"callback": (required) a callback to receive websocket events"dbglog": a closure taking a single string for detailed technical connection logging"errlog": a closure accepting a single string for error logging"log": a closure accepting a single string for logging"yield": a closure to yield current thread execution | WebSocketClient::WebSocketConnectionObject::constructor | ( | string | name, |
| string | description, | ||
| string | url, | ||
| hash< auto > | attributes = {}, |
||
| hash< auto > | options = {} |
||
| ) |
creates the WebSocketConnectionObject connection object
| name | the name of the connection |
| description | connection description |
| url | connection URL (potentially with password info) |
| attributes | various attributes. See below |
| options | connection options |
See AbstractConnection::constructor() for attributes and options reference.
| CONNECTION-OPTION-ERROR | missing or invalid connection option |
| DataProvider::AbstractDataProvider WebSocketClient::WebSocketConnectionObject::getDataProvider | ( | ) |
returns an WebSocketClientDataProvider object for this connection
|
protected |
returns a WebSocketClient object
| connect | if True, then WebSocketClient::connect() is called |
| rtopts | supports the following runtime options in getImpl():
|
| *hash<auto> WebSocketClient::WebSocketConnectionObject::getRuntimeOptions | ( | ) |
returns runtime options
"callback": (required) a callback to receive websocket events"dbglog": a closure taking a single string for detailed technical connection logging"errlog": a closure accepting a single string for error logging"log": a closure accepting a single string for logging"yield": a closure to yield current thread execution | bool WebSocketClient::WebSocketConnectionObject::hasDataProvider | ( | ) |
returns True, as the connection returns a data provider with the getDataProvider() method