paho-mqtt-cpp
MQTT C++ Client for POSIX and Windows
Loading...
Searching...
No Matches
Public Member Functions | Data Fields | Friends
mqtt::subscribe_response Struct Reference

#include <server_response.h>

Inheritance diagram for mqtt::subscribe_response:
mqtt::server_response

Public Member Functions

 subscribe_response (MQTTAsync_successData5 *rsp)
 
 subscribe_response (size_t n, MQTTAsync_successData *rsp)
 
const std::vector< ReasonCode > & get_reason_codes () const
 
- Public Member Functions inherited from mqtt::server_response
 server_response ()
 
 server_response (const properties &props)
 
 server_response (properties &&props)
 
virtual ~server_response ()
 
const propertiesget_properties () const
 

Data Fields

std::vector< ReasonCodereasonCodes_
 

Friends

class token
 

Detailed Description

Response for subscribe messages

Constructor & Destructor Documentation

◆ subscribe_response() [1/2]

mqtt::subscribe_response::subscribe_response ( MQTTAsync_successData5 *  rsp)
inline

Create v5 subscribe response.

Parameters
rspThe v5 response struct from the C lib

◆ subscribe_response() [2/2]

mqtt::subscribe_response::subscribe_response ( size_t  n,
MQTTAsync_successData *  rsp 
)
inline

Create v3 subscribe response.

Parameters
nThe number of subscription topics
rspThe v3 response struct from the C lib

Member Function Documentation

◆ get_reason_codes()

const std::vector< ReasonCode > & mqtt::subscribe_response::get_reason_codes ( ) const
inline

Gets the reason codes from the server response. On a subscribe ack there is a reason code for each topic that was sent in the subscribe packet. Each tells the granted QoS for the corresponding topic.

Returns
A collection of return codes corresponding to subscribing each topic. On success, this is the granted QoS for each topic. On failure it is the reason for the failure.

Friends And Related Function Documentation

◆ token

friend class token
friend

Field Documentation

◆ reasonCodes_

std::vector<ReasonCode> mqtt::subscribe_response::reasonCodes_

The reason/result code for each topic request.


The documentation for this struct was generated from the following file: