$darkmode
Qore WebSocketClient Module Reference 2.2
WebSocketClient::WebSocketClientWaitForMessageDataProvider Class Reference

WebSocket client wait for message from server API data provider. More...

Inherits AbstractDataProvider.

Public Member Functions

 constructor (WebSocketClientDataProviderBase base)
 Creates the object.
 
 destructor ()
 Deletes the object.
 
string getName ()
 Returns the data provider name.
 
hash< DataProviderInfo > getStaticInfoImpl ()
 Returns data provider static info.
 

Public Attributes

const ProviderInfo
 Provider info.
 
const RequestType = new WebSocketClientWaitForMessageRequestDataType()
 Request type.
 
const ResponseType = AbstractDataProviderTypeMap."any"
 Response type.
 

Protected Member Functions

auto doRequestImpl (auto req, *hash< auto > request_options)
 Makes a request and returns the response. More...
 
*AbstractDataProviderType getRequestTypeImpl ()
 Returns the description of a successful request message, if any. More...
 
*AbstractDataProviderType getResponseTypeImpl ()
 Returns the description of a response message, if this object represents a response message. More...
 

Detailed Description

WebSocket client wait for message from server API data provider.

Member Function Documentation

◆ doRequestImpl()

auto WebSocketClient::WebSocketClientWaitForMessageDataProvider::doRequestImpl ( auto  req,
*hash< auto >  request_options 
)
protected

Makes a request and returns the response.

Parameters
reqthe request to serialize and make according to the request type
request_optionsthe request options; will be processed by validateRequestOptions()
Returns
the response to the request

◆ getRequestTypeImpl()

*AbstractDataProviderType WebSocketClient::WebSocketClientWaitForMessageDataProvider::getRequestTypeImpl ( )
protected

Returns the description of a successful request message, if any.

Returns
the request type for this provider

◆ getResponseTypeImpl()

*AbstractDataProviderType WebSocketClient::WebSocketClientWaitForMessageDataProvider::getResponseTypeImpl ( )
protected

Returns the description of a response message, if this object represents a response message.

Returns
the response type for this response message