1. Epic GamesDeveloper
  3. IMQTTClient

IMQTTClient

API > API/Plugins > API/Plugins/MQTTCore

   
Name IMQTTClient
Type class
Header File /Engine/Plugins/Protocols/MQTT/Source/MQTTCore/Public/IMQTTClient.h
Include Path #include "IMQTTClient.h"

Syntax

class IMQTTClient

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IMQTTClient()

   IMQTTClient.h  

Typedefs

Name Type Remarks Include Path
FOnConnect TMulticastDelegate_OneParam< void, EMQTTConnectReturnCode >   IMQTTClient.h
FOnDisconnect TMulticastDelegate_NoParams< void >   IMQTTClient.h
FOnMessage TMulticastDelegate_OneParam< void, const FMQTTClientMessage & >   IMQTTClient.h
FOnPublish TMulticastDelegate_NoParams< void >   IMQTTClient.h
FOnSubscribe TMulticastDelegate_OneParam< void, TArray< FMQTTSubscribeResult > >   IMQTTClient.h
FOnUnsubscribe TMulticastDelegate_NoParams< void >   IMQTTClient.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

TFuture< EMQTTConnectReturnCode > Connect ( bool bCleanSession
)

 Connect using the clients URL. Set bCleanSession = false to resume previous session. IMQTTClient.h  

TFuture< void > Disconnect()

   IMQTTClient.h  

FGuid GetClientId()

 Unique Id for this client. IMQTTClient.h  

const FMQTTURL & GetURL()

 URL for this client. IMQTTClient.h  

bool IsConnected()

 Is client currently connected? IMQTTClient.h  

bool IsValid()

 Validity of this client. IMQTTClient.h  

FOnConnect & OnConnect()

   IMQTTClient.h  

FOnDisconnect & OnDisconnect()

   IMQTTClient.h  

FOnMessage & OnMessage()

   IMQTTClient.h  

FOnPublish & OnPublish()

   IMQTTClient.h  

FOnSubscribe & OnSubscribe()

   IMQTTClient.h  

FOnUnsubscribe & OnUnsubscribe()

   IMQTTClient.h  

TFuture< bool > Ping ( const float& InTimeout
)

 Returns true if response received before timeout. IMQTTClient.h  

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) IMQTTClient.h  

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) IMQTTClient.h  

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

   IMQTTClient.h  

TFuture< FMQTTSubscribeResult > Subscribe ( const FString& InTopicFilter,
CallableType&& InOnMessage,
EMQTTQualityOfService InQoS
)

 Only for single sub IMQTTClient.h  

TFuture< bool > Unsubscribe ( const TSet< FString >& InTopicFilters
)

   IMQTTClient.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page