1. Epic GamesDeveloper
  3. IMQTTClient

IMQTTClient

API > API/Plugins > API/Plugins/MQTTCore

References

   
Module MQTTCore
Header /Engine/Plugins/Protocols/MQTT/Source/MQTTCore/Public/IMQTTClient.h
Include #include "IMQTTClient.h"

Syntax

class IMQTTClient

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function TFuture< EMQTTConnectReturnCode >

Connect ( bool bCleanSession
)

 Connect using the clients URL. Set bCleanSession = false to resume previous session.
Public function TFuture< void > Virtual TCancellablePromise Connect();
Public function Const FGuid Unique Id for this client.
Public function Const const FMQTTURL &

GetURL ()

 URL for this client.
Public function Const bool Is client currently connected?
Public function Const bool

IsValid ()

 Validity of this client.
Public function FOnConnect &  
Public function FOnDisconnect &  
Public function FOnMessage &  
Public function FOnPublish &  
Public function FOnSubscribe &  
Public function FOnUnsubscribe &  
Public function TFuture< bool >

Ping ( const float& InTimeout
)

 Returns true if response received before timeout.
Public function TFuture< bool >
Publish

( const FString& InTopic,
const TArray< uint8 >& InPayload,
EMQTTQualityOfService InQoS,
const bool bInRetain
)

 Return true if the entire operation was successful (depends on QoS)
Public function TFuture< bool >
Publish

( const FString& InTopic,
const FString& InPayload,
EMQTTQualityOfService InQoS,
const bool bInRetain
)

 Return true if the entire operation was successful (depends on QoS)
Public function TFuture< TArray< FMQTTSubscribeResult > >

Subscribe ( const TArray< TPair< FString, EMQTTQualityOfService >>& InTopicFilterQoSPairs
)

  
Public function TFuture< FMQTTSubscribeResult >

Subscribe ( const FString& InTopicFilter,
CallableType&& InOnMessage,
EMQTTQualityOfService InQoS
)

 Only for single sub
Public function TFuture< bool >

Unsubscribe ( const TSet< FString >& InTopicFilters
)

  

Typedefs

Name Description
FOnConnect  
FOnDisconnect  
FOnMessage  
FOnPublish  
FOnSubscribe  
FOnUnsubscribe  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page