async_mqtt 9.0.1
Loading...
Searching...
No Matches
Collaboration diagram for predefined underlying layer (Websocket):

Typedefs

using async_mqtt::protocol::ws = bs::websocket::stream<mqtt>
 Type alias of boost::beast::websocket::stream of mqtt.
 

Functions

template<typename NextLayer , typename CompletionToken = as::default_completion_token_t< typename bs::websocket::stream<NextLayer>::executor_type >>
 async_mqtt::async_underlying_handshake (bs::websocket::stream< NextLayer > &layer, std::string_view host, std::string_view port, std::string_view path, CompletionToken &&token=as::default_completion_token_t< typename bs::websocket::stream< NextLayer >::executor_type >{})
 Websocket handshake This function does underlying layers handshaking prior to Websocket handshake.
 
template<typename NextLayer , typename CompletionToken = as::default_completion_token_t< typename bs::websocket::stream<NextLayer>::executor_type >>
 async_mqtt::async_underlying_handshake (bs::websocket::stream< NextLayer > &layer, std::string_view host, std::string_view port, CompletionToken &&token=as::default_completion_token_t< typename bs::websocket::stream< NextLayer >::executor_type >{})
 Websocket handshake This function does underlying layers handshaking prior to Websocket handshake Websocket path is set as "/".
 

Detailed Description

Function Documentation

◆ async_underlying_handshake() [1/2]

template<typename NextLayer , typename CompletionToken = as::default_completion_token_t< typename bs::websocket::stream<NextLayer>::executor_type >>
async_mqtt::async_underlying_handshake ( bs::websocket::stream< NextLayer > & layer,
std::string_view host,
std::string_view port,
CompletionToken && token = as::default_completion_token_t< typename bs::websocket::stream< NextLayer >::executor_type >{} )

Websocket handshake This function does underlying layers handshaking prior to Websocket handshake Websocket path is set as "/".

Parameters
layerWebsocket layer
hosthost name or IP address to connect
portport number to connect
tokencompletion token. signature is void(error_code)
Returns
deduced by token

Requirements

◆ async_underlying_handshake() [2/2]

template<typename NextLayer , typename CompletionToken = as::default_completion_token_t< typename bs::websocket::stream<NextLayer>::executor_type >>
async_mqtt::async_underlying_handshake ( bs::websocket::stream< NextLayer > & layer,
std::string_view host,
std::string_view port,
std::string_view path,
CompletionToken && token = as::default_completion_token_t< typename bs::websocket::stream< NextLayer >::executor_type >{} )

Websocket handshake This function does underlying layers handshaking prior to Websocket handshake.

Parameters
layerWebsocket layer
hosthost name or IP address to connect
portport number to connect
pathwebsocket path
tokencompletion token. signature is void(error_code)
Returns
deduced by token

Requirements