Qore WebSocketClient Module Reference 2.2
Loading...
Searching...
No Matches
WebSocketClient::WebSocketConnectionObject Class Reference

class for websocket connections; returns an object of class WebSocketClient for receiving websocket events from a websocket server More...

#include <WebSocketClient.qm.dox.h>

Inheritance diagram for WebSocketClient::WebSocketConnectionObject:
[legend]

Public Member Methods

 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.
 

Private Member Methods

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.
 

Detailed Description

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 milliseconds

also 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

Member Function Documentation

◆ constructor()

WebSocketClient::WebSocketConnectionObject::constructor ( string  name,
string  description,
string  url,
hash< auto >  attributes = {},
hash< auto >  options = {} 
)

creates the WebSocketConnectionObject connection object

Parameters
namethe name of the connection
descriptionconnection description
urlconnection URL (potentially with password info)
attributesvarious attributes. See below
optionsconnection options

See AbstractConnection::constructor() for attributes and options reference.

Exceptions
CONNECTION-OPTION-ERRORmissing or invalid connection option

◆ getDataProvider()

DataProvider::AbstractDataProvider WebSocketClient::WebSocketConnectionObject::getDataProvider ( )

returns an WebSocketClientDataProvider object for this connection

Returns
an WebSocketClientDataProvider object for this connection
See also
hasDataProvider()

◆ getImpl()

WebSocketClient WebSocketClient::WebSocketConnectionObject::getImpl ( bool  connect = True,
*hash< auto >  rtopts 
)
privatevirtual

returns a WebSocketClient object

Parameters
connectif True, then WebSocketClient::connect() is called
rtoptssupports 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
Returns
a WebSocketClient object

Implements ConnectionProvider::AbstractConnection.

◆ getRuntimeOptions()

*hash< auto > WebSocketClient::WebSocketConnectionObject::getRuntimeOptions ( )

returns runtime options

Returns
a hash with the following keys reflecting support for the corresponding 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

◆ hasDataProvider()

bool WebSocketClient::WebSocketConnectionObject::hasDataProvider ( )

returns True, as the connection returns a data provider with the getDataProvider() method

Returns
True, as the connection returns a data provider with the getDataProvider() method
See also
getDataProvider()