Finish init/deinit PubnubClient.

Author: KGronek-Pubnub

Source/PubnubLibrary/Private/PubnubClient.cpp

@@ -3,6 +3,7 @@
 
 #include "PubnubClient.h"
 #include "PubNub.h"
+#include "PubnubInternalMacros.h"
 #include "PubnubSubsystem.h"
 #include "Threads/PubnubFunctionThread.h"
 #include "FunctionLibraries/PubnubUtilities.h"
@@ -76,15 +77,57 @@ void UPubnubClient::InitWithConfig(UPubnubSubsystem* InPubnubSubsystem, FPubnubC
 
 void UPubnubClient::DeinitializeClient()
 {
+	if(!IsInitialized)
+	{return;}
+
+	if(PubnubCallsThread)
+	{
+		PubnubCallsThread->Stop();
+		delete PubnubCallsThread;
+		PubnubCallsThread = nullptr;
+	}
+	
+	//Unsubscribe from all channels and groups so this user will not be visible for others anymore
+	UnsubscribeFromAll_priv();
+	
 	IsInitialized = false;
 	PubnubSubsystem = nullptr;
+
+	if(ctx_pub && ctx_ee)
+	{
+		//We set this to prevent crash from C-Core when it's trying to clean up provider made in UE
+		pubnub_set_crypto_module(ctx_pub, nullptr);
+		pubnub_set_crypto_module(ctx_ee, nullptr);
+
+		//Clean up Crypto bridge if it was created
+		if(CryptoBridge)
+		{
+			CryptoBridge->CleanUpCryptoBridge();
+		}
+
+		//Clean up C-core pubnub contexts
+		pubnub_free(ctx_pub);
+		pubnub_free(ctx_ee);
+		ctx_pub = nullptr;
+		ctx_ee = nullptr;
+	}
+	
+	IsUserIDSet = false;
+	delete[] AuthTokenBuffer;
+	AuthTokenBuffer = nullptr;
+	AuthTokenLength = 0;
+
+	SubscriptionResultDelegates.Empty();
+
+	//Notify that Deinitialization is finished
+	OnClientDeinitialized.Broadcast(ClientID);
 }
 
 void UPubnubClient::SavePubnubConfig(const FPubnubConfig& InConfig)
 {
 	PubnubConfig = InConfig;
 
-	// Safely copy all keys using the utility function
+	//Safely copy all keys using the utility function
 	UPubnubUtilities::SafeCopyFStringToCharBuffer(PublishKey, PublishKeySize + 1, InConfig.PublishKey, TEXT("PublishKey"));
 	UPubnubUtilities::SafeCopyFStringToCharBuffer(SubscribeKey, PublishKeySize + 1, InConfig.SubscribeKey, TEXT("SubscribeKey"));
 	UPubnubUtilities::SafeCopyFStringToCharBuffer(SecretKey, SecretKeySize + 1, InConfig.SecretKey, TEXT("SecretKey"));
@@ -202,3 +245,47 @@ void UPubnubClient::InitPubnub_priv(const FPubnubConfig& Config)
 		SetSecretKey();
 	}
 }
+
+void UPubnubClient::UnsubscribeFromAll_priv(FPubnubOnSubscribeOperationResponseNative OnUnsubscribeFromAllResponse)
+{
+	if(ChannelSubscriptions.IsEmpty() && ChannelGroupSubscriptions.IsEmpty())
+	{
+		UPubnubUtilities::CallPubnubDelegate(OnUnsubscribeFromAllResponse, FPubnubOperationResult({200, false, ""}));
+		return;
+	}
+
+	PUBNUB_ENSURE_USER_ID_IS_SET(OnUnsubscribeFromAllResponse);
+
+	//All subscription related operations are non blocking, so we lock ActionThread manually,
+	//make it wait with calling other function until we have subscription result
+	PubnubCallsThread->LockForSubscribeOperation();
+
+	pubnub_unsubscribe_all(ctx_ee);
+
+    //Clean up all channel subscriptions
+    for(auto& Pair : ChannelSubscriptions)
+    {
+        if(Pair.Value)
+        {
+            if(Pair.Value->Subscription)
+            {
+                pubnub_subscription_free(&Pair.Value->Subscription);
+            }
+            delete Pair.Value;
+        }
+    }
+    for(auto& Pair : ChannelGroupSubscriptions)
+    {
+        if(Pair.Value)
+        {
+            if(Pair.Value->Subscription)
+            {
+                pubnub_subscription_free(&Pair.Value->Subscription);
+            }
+            delete Pair.Value;
+        }
+    }
+	
+	ChannelSubscriptions.Empty();
+	ChannelGroupSubscriptions.Empty();
+}

Source/PubnubLibrary/Public/PubnubClient.h

@@ -9,15 +9,16 @@
 #include "PubnubClient.generated.h"
 
 class UPubnubSubsystem;
+class UPubnubCryptoBridge;
 class FPubnubFunctionThread;
 struct CCoreSubscriptionCallback;
 
-
 struct pubnub_;
 typedef struct pubnub_ pubnub_t;
 enum pubnub_res;
 
 
+DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FPubnubOnClientDeinitialized, int, ClientID);
 DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FPubnubOnSubscriptionStatusChanged, EPubnubSubscriptionStatus, Status, FPubnubSubscriptionStatusData, StatusData);
 DECLARE_MULTICAST_DELEGATE_TwoParams(FPubnubOnSubscriptionStatusChangedNative, EPubnubSubscriptionStatus Status, const FPubnubSubscriptionStatusData& StatusData);
 
@@ -39,16 +40,20 @@ class PUBNUBLIBRARY_API UPubnubClient : public UObject
 
 public:
 
-	/**Listener to react for subscription status changed */
+	/**Listener to react for subscription status changed*/
 	UPROPERTY(BlueprintAssignable, Category = "Pubnub|Delegates")
 	FPubnubOnSubscriptionStatusChanged OnSubscriptionStatusChanged;
 
 	/**Listener to react for subscription status changed , equivalent that accepts lambdas*/
 	FPubnubOnSubscriptionStatusChangedNative OnSubscriptionStatusChangedNative;
+
+	/**Delegate that is called when PubnubClient is deinitialized*/
+	UPROPERTY(BlueprintAssignable, Category = "Pubnub|Delegates")
+	FPubnubOnClientDeinitialized OnClientDeinitialized;
 
 
-	UFUNCTION(BlueprintCallable, Category="PubnubClient")
-	int GetClientID() {return ClientID;};
+	UFUNCTION(BlueprintPure, BlueprintCallable, Category="PubnubClient")
+	int GetClientID() const {return ClientID;};
 
 	UFUNCTION(BlueprintCallable, Category="PubnubClient")
 	void DestroyClient();
@@ -133,8 +138,25 @@ class PUBNUBLIBRARY_API UPubnubClient : public UObject
 	int ClientID = -1;
 	FString DebugName = "";
 	bool IsInitialized = false;
+	bool IsUserIDSet = false;
 
-#pragma endregion 
+#pragma endregion
+
+#pragma region PUBNUB CRYPTO
+	
+	//CryptoBridge class that holds provided CryptoModule and inserts it into C-Core system - it keeps all required references alive
+	UPROPERTY()
+	TObjectPtr<UPubnubCryptoBridge> CryptoBridge;
+
+#pragma endregion
+
+#pragma region PUBNUB AUTH
+
+	//Auth token has to be kept alive for the lifetime of the sdk, so this is the container for it
+	char* AuthTokenBuffer = nullptr;
+	size_t AuthTokenLength = 0;
+
+#pragma endregion
 
 #pragma region PUBNUB CONFIG
 
@@ -154,9 +176,7 @@ class PUBNUBLIBRARY_API UPubnubClient : public UObject
 
 #pragma endregion 
 
-	//TODO:: Move these functions to the logger
-	void PubnubError(FString ErrorMessage, EPubnubErrorType ErrorType = EPubnubErrorType::PET_Error);
-	void PubnubResponseError(pubnub_res PubnubResponse, FString ErrorMessage);
+#pragma region PUBNUB SUBSCRIPTION
 
 	//Storage for global subscriptions (not from Entities)
 	TMap<FString, CCoreSubscriptionCallback*> ChannelSubscriptions;
@@ -167,6 +187,13 @@ class PUBNUBLIBRARY_API UPubnubClient : public UObject
 
 	void OnCCoreSubscriptionStatusReceived(int StatusEnum, const void* StatusData);
 
+#pragma endregion
+
+	//TODO:: Move these functions to the logger
+	void PubnubError(FString ErrorMessage, EPubnubErrorType ErrorType = EPubnubErrorType::PET_Error);
+	void PubnubResponseError(pubnub_res PubnubResponse, FString ErrorMessage);
 
 	void InitPubnub_priv(const FPubnubConfig& Config);
+	void UnsubscribeFromAll_priv(FPubnubOnSubscribeOperationResponseNative OnUnsubscribeFromAllResponse = nullptr);
 };
+