Add ConnectionStatusListener and functions to Reconnect, Disconnect all subscriptions.

KGronek-Pubnub · KGronek-Pubnub · commit 03e616cb5283 · 2025-06-02T11:00:58.000+02:00
diff --git a/Source/PubnubChatSDK/Private/PubnubChat.cpp b/Source/PubnubChatSDK/Private/PubnubChat.cpp
@@ -33,9 +33,23 @@ UPubnubChat* UPubnubChat::Create(Pubnub::Chat Chat)
 		};
 	};
 	Chat.register_logger_callback(PubnubChatLogLambda);
+	
 	return NewChat;
 }
 
+void UPubnubChat::InitConnectionListener()
+{
+	if(!IsInternalChatValid()) {return;}
+	
+	auto ConnectionStatusListener = [this](Pubnub::pn_connection_status status, Pubnub::ConnectionStatusData status_data)
+	{
+		FPubnubConnectionStatusData StatusData = FPubnubConnectionStatusData({UPubnubChatUtilities::PubnubStringToFString(status_data.reason)});
+		OnConnectionStatusChanged.Broadcast((EPubnubConnectionStatus)status, StatusData);
+		OnConnectionStatusChangedNative.Broadcast((EPubnubConnectionStatus)status, StatusData);
+	};
+	InternalChat->add_connection_status_listener(ConnectionStatusListener);
+}
+
 void UPubnubChat::DestroyChat()
 {
 	delete InternalChat;
@@ -546,6 +560,38 @@ UPubnubAccessManager* UPubnubChat::GetAccessManager()
 	return UPubnubAccessManager::Create(InternalChat->access_manager());
 }
 
+bool UPubnubChat::ReconnectSubscriptions()
+{
+	if(!IsInternalChatValid()) {return false;}
+
+	try
+	{
+		return InternalChat->reconnect_subscriptions();
+	}
+	catch (std::exception& Exception)
+	{
+		UE_LOG(PubnubChatLog, Error, TEXT("Reconnect Subscriptions error: %s"), UTF8_TO_TCHAR(Exception.what()));
+	}
+
+	return false;
+}
+
+bool UPubnubChat::DisconnectSubscriptions()
+{
+	if(!IsInternalChatValid()) {return false;}
+
+	try
+	{
+		return InternalChat->disconnect_subscriptions();
+	}
+	catch (std::exception& Exception)
+	{
+		UE_LOG(PubnubChatLog, Error, TEXT("Disconnect Subscriptions error: %s"), UTF8_TO_TCHAR(Exception.what()));
+	}
+
+	return false;
+}
+
 bool UPubnubChat::IsInternalChatValid()
 {
 	if(InternalChat == nullptr)
diff --git a/Source/PubnubChatSDK/Private/PubnubChatSubsystem.cpp b/Source/PubnubChatSDK/Private/PubnubChatSubsystem.cpp
@@ -37,6 +37,7 @@ UPubnubChat* UPubnubChatSubsystem::InitChat(FString PublishKey, FString Subscrib
 	UPubnubChatUtilities::FStringToPubnubString(SubscribeKey),UPubnubChatUtilities::FStringToPubnubString(UserID), CppConfig));
 		//Bind OnChatDestroyed, so Subsystem can clear a variable when Chat is destroyed manually by an user
 		Chat->OnChatDestroyed.AddDynamic(this, &UPubnubChatSubsystem::OnChatDestroyed);
+		Chat->InitConnectionListener();
 		
 		return Chat;
 	}
diff --git a/Source/PubnubChatSDK/Public/PubnubChat.h b/Source/PubnubChatSDK/Public/PubnubChat.h
@@ -12,6 +12,8 @@
 
 DECLARE_DYNAMIC_DELEGATE_OneParam(FOnPubnubEventReceived, FPubnubEvent, Event);
 DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnPubnubChatDestroyed);
+DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnConnectionStatusChanged, EPubnubConnectionStatus, Status, const FPubnubConnectionStatusData&, StatusData);
+DECLARE_MULTICAST_DELEGATE_TwoParams(FOnConnectionStatusChangedNative, EPubnubConnectionStatus Status, const FPubnubConnectionStatusData& StatusData);
 
 class UPubnubChannel;
 class UPubnubUser;
@@ -152,20 +154,19 @@ struct FPubnubEventsHistoryWrapper
 	}
 };
 
-// TODO: Probably it should be moved into new directory but I'm not sure if it requires any additional actions:
-// -->
+
 USTRUCT(BlueprintType)
 struct FPubnubUserMentionData 
 {
     GENERATED_BODY();
 
-    UPROPERTY(BlueprintReadWrite, VisibleAnywhere, Category = "PubnubChat") FString ChannelID;
-    UPROPERTY(BlueprintReadWrite, VisibleAnywhere, Category = "PubnubChat") FString UserID;
+    UPROPERTY(BlueprintReadWrite, VisibleAnywhere, Category = "PubnubChat") FString ChannelID = "";
+    UPROPERTY(BlueprintReadWrite, VisibleAnywhere, Category = "PubnubChat") FString UserID = "";
     UPROPERTY(BlueprintReadWrite, VisibleAnywhere, Category = "PubnubChat") FPubnubEvent Event;
     UPROPERTY(BlueprintReadWrite, VisibleAnywhere, Category = "PubnubChat") UPubnubMessage* Message = nullptr;
 
-    UPROPERTY(BlueprintReadWrite, VisibleAnywhere, Category = "PubnubChat") FString ParentChannelID;
-    UPROPERTY(BlueprintReadWrite, VisibleAnywhere, Category = "PubnubChat") FString ThreadChannelID;
+    UPROPERTY(BlueprintReadWrite, VisibleAnywhere, Category = "PubnubChat") FString ParentChannelID = "";
+    UPROPERTY(BlueprintReadWrite, VisibleAnywhere, Category = "PubnubChat") FString ThreadChannelID = "";
 
     FPubnubUserMentionData() = default;
     FPubnubUserMentionData(Pubnub::UserMentionData& MentionData) :
@@ -197,7 +198,7 @@ struct FPubnubUserMentionDataList
         }
     }
 };
-// <--
+
 
 /**
  * 
@@ -216,7 +217,14 @@ class PUBNUBCHATSDK_API UPubnubChat : public UObject
 		}
 	}
 
-	UPROPERTY(BlueprintAssignable, Category = "Pubnub Chat")
+	/**Listener to react for connection status changed */
+	UPROPERTY(BlueprintAssignable, Category = "Pubnub Chat|Delegates")
+	FOnConnectionStatusChanged OnConnectionStatusChanged;
+
+	/**Listener to react for connection status changed , equivalent that accepts lambdas*/
+	FOnConnectionStatusChangedNative OnConnectionStatusChangedNative;
+
+	UPROPERTY(BlueprintAssignable, Category = "Pubnub Chat|Delegates")
 	FOnPubnubChatDestroyed OnChatDestroyed;
 	
 	UFUNCTION(BlueprintCallable, Category="Pubnub Chat")
@@ -332,8 +340,30 @@ class PUBNUBCHATSDK_API UPubnubChat : public UObject
 	UFUNCTION(BlueprintCallable, Category = "Pubnub Chat|Access Manager")
 	UPubnubAccessManager* GetAccessManager();
 
+	
+	/* CONNECTION STATUS */
+
+	/**
+	 * Tries to reconnect all existing subscriptions. Mostly call this if DisconnectSubscriptions was called previously
+	 * or if received ConnectionError from OnConnectionStatusChanged to restore all existing subscriptions and listeners.
+	 * @return true if operation succeeded.
+	 */
+	UFUNCTION(BlueprintCallable, Category = "Pubnub Chat|Connection Status")
+	bool ReconnectSubscriptions();
+
+	/**
+	 * Tries to disconnect (pause) all active subscriptions - listeners. This will be called for all objects: channels, users,
+	 * messages, etc. Call ReconnectSubscriptions to restore them.
+	 * @return true if operation succeeded.
+	 */
+	UFUNCTION(BlueprintCallable, Category = "Pubnub Chat|Connection Status")
+	bool DisconnectSubscriptions();
+	
+
 	//Internal usage only
 	static UPubnubChat* Create(Pubnub::Chat Chat);
+	//Internal usage only, to listen for Connection Statuses use OnConnectionStatusChanged or OnConnectionStatusChangedNative
+	void InitConnectionListener();
     
 private:
 	bool IsInternalChatValid();
diff --git a/Source/PubnubChatSDK/Public/PubnubChatEnumLibrary.h b/Source/PubnubChatSDK/Public/PubnubChatEnumLibrary.h
@@ -66,4 +66,12 @@ enum class EPubnubMessageDraftSuggestionSource : uint8
 {
 	PMDSS_Channel			UMETA(DisplayName="Channel"),
 	PMDSS_Global			UMETA(DisplayName="Global"),
+};
+
+UENUM(BlueprintType)
+enum class EPubnubConnectionStatus : uint8
+{
+	PCS_CONNECTION_ONLINE		UMETA(DisplayName="ConnectionOnline"),
+	PCS_CONNECTION_OFFLINE		UMETA(DisplayName="ConnectionOffline"),
+	PCS_CONNECTION_ERROR		UMETA(DisplayName="ConnectionError")
 };
diff --git a/Source/PubnubChatSDK/Public/PubnubChatStructLibrary.h b/Source/PubnubChatSDK/Public/PubnubChatStructLibrary.h
@@ -482,4 +482,13 @@ struct FPubnubMessageDraftConfig
 			ChannelLimit
 		});
 	}
+};
+
+USTRUCT(BlueprintType)
+struct FPubnubConnectionStatusData
+{
+	GENERATED_BODY()
+	
+	/**Error details in case of ConnectionError.*/
+	UPROPERTY(BlueprintReadWrite, VisibleAnywhere, Category = "PubnubChat") FString Reason = "";
 };
diff --git a/Source/ThirdParty/sdk/include/pubnub_chat/chat.hpp b/Source/ThirdParty/sdk/include/pubnub_chat/chat.hpp
@@ -110,6 +110,12 @@ namespace Pubnub {
         bool is_more;
     };
 
+    struct ConnectionStatusData
+    {
+        /**Error details in case of ConnectionError.*/
+        Pubnub::String reason = "";
+    };
+
 
 
     class Chat {
@@ -170,11 +176,19 @@ namespace Pubnub {
             PN_CHAT_EXPORT void remove_thread_channel(const Pubnub::Message& message) const;
 
             /* PAM */
+
             PN_CHAT_EXPORT Pubnub::AccessManager access_manager() const;
 
             /* LOG */
+
             PN_CHAT_EXPORT void register_logger_callback(std::function<void(Pubnub::pn_log_level, const char*)> callback);
 
+            /* CONNECTION STATUS */
+            
+            PN_CHAT_EXPORT void add_connection_status_listener(std::function<void(Pubnub::pn_connection_status status, Pubnub::ConnectionStatusData status_data)> connection_status_callback) const;
+            PN_CHAT_EXPORT bool reconnect_subscriptions() const;
+            PN_CHAT_EXPORT bool disconnect_subscriptions() const;
+
         private:
             Chat(const Pubnub::String& publish_key, const Pubnub::String& subscribe_key, const Pubnub::String& user_id, const ChatConfig& config);
             void store_user_activity_timestamp() const;
diff --git a/Source/ThirdParty/sdk/include/pubnub_chat/enums.hpp b/Source/ThirdParty/sdk/include/pubnub_chat/enums.hpp
@@ -47,6 +47,12 @@ enum pn_log_level {
     Trace
 };
 
+enum pn_connection_status {
+    PCS_CONNECTION_ONLINE,
+    PCS_CONNECTION_OFFLINE,
+    PCS_CONNECTION_ERROR
+};
+
 }
 
 #endif // PN_ENUMS_HPP
diff --git a/Source/ThirdParty/sdk/lib/win64/pubnub-chat.dll b/Source/ThirdParty/sdk/lib/win64/pubnub-chat.dll
diff --git a/Source/ThirdParty/sdk/lib/win64/pubnub-chat.lib b/Source/ThirdParty/sdk/lib/win64/pubnub-chat.lib

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ UPubnubChat* UPubnubChatSubsystem::InitChat(FString PublishKey, FString Subscrib`
`37`	`37`	`UPubnubChatUtilities::FStringToPubnubString(SubscribeKey),UPubnubChatUtilities::FStringToPubnubString(UserID), CppConfig));`
`38`	`38`	`//Bind OnChatDestroyed, so Subsystem can clear a variable when Chat is destroyed manually by an user`
`39`	`39`	`Chat->OnChatDestroyed.AddDynamic(this, &UPubnubChatSubsystem::OnChatDestroyed);`
	`40`	`+ Chat->InitConnectionListener();`
`40`	`41`
`41`	`42`	`return Chat;`
`42`	`43`	`}`