Updated from pipeline, Version : 23.1.4

Author: AccelByte-Build

.variables

@@ -1,9 +1,9 @@
 export LEVEL=CRITICAL
 export REPO_NAME=justice-unreal-sdk-plugin
-export WORKDIR=/tmp/pipelines/4323564601/874313607/
-export COMMIT_HASH=3c26f22d5ea2d3bc15f8f8a7e3e8e9792e7e46b0
-export GIT_HASH=3c26f22d5ea2d3bc15f8f8a7e3e8e9792e7e46b0
-export VERSION=23.1.3
-export REVISION_ID=23.1.3
+export WORKDIR=/tmp/pipelines/4355976397/879798516/
+export COMMIT_HASH=654e9e506c90e3375e6430c4dee8425de7aa1064
+export GIT_HASH=654e9e506c90e3375e6430c4dee8425de7aa1064
+export VERSION=23.1.4
+export REVISION_ID=23.1.4
 export [email protected]
-export COMMIT_MESSAGE_BASE64='Y2hvcmUocmVsZWFzZSk6IDIzLjEuMyAtIGNvbW1pdGVkIGFuZCB0YWdnZWQgYnkgSmVua2lucwo='
+export COMMIT_MESSAGE_BASE64='Y2hvcmUocmVsZWFzZSk6IDIzLjEuNCAtIGNvbW1pdGVkIGFuZCB0YWdnZWQgYnkgSmVua2lucwo='

AccelByteUe4Sdk.uplugin

@@ -1,7 +1,7 @@
 {
     "FileVersion": 3,
-    "Version": 34,
-    "VersionName": "23.1.3",
+    "Version": 35,
+    "VersionName": "23.1.4",
     "FriendlyName": "AccelByte Unreal Engine SDK",
     "Description": "Official AccelByte SDK for Unreal Engine 4",
     "Category": "Online Platform",

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [23.1.4](https://bitbucket.org/accelbyte/justice-unreal-sdk-plugin/branches/compare/23.1.4%0D23.1.3) (2023-05-26)
+
+
+### Features
+
+* **DS:** add DSM heartbeat API ([eb71bc8](https://bitbucket.org/accelbyte/justice-unreal-sdk-plugin/commits/eb71bc8160d9c1a5a1f64a71a88de2c4b234903b))
+
 ### [23.1.3](https://bitbucket.org/accelbyte/justice-unreal-sdk-plugin/branches/compare/23.1.3%0D23.1.2) (2023-05-22)
 
 ### [23.1.2](https://bitbucket.org/accelbyte/justice-unreal-sdk-plugin/branches/compare/23.1.2%0D23.1.1) (2023-05-17)

Content/CompatibilityMap.json

@@ -44,12 +44,12 @@
     "maxVersion": "1.18.1"
   },
   "lobby": {
-    "minVersion": "3.19.0",
-    "maxVersion": "3.19.0"
+    "minVersion": "3.20.0",
+    "maxVersion": "3.20.0"
   },
   "dsmcontroller": {
-    "minVersion": "6.3.0",
-    "maxVersion": "6.3.0"
+    "minVersion": "6.3.2",
+    "maxVersion": "6.3.2"
   },
   "game-telemetry": {
     "minVersion": "1.17.2",

Source/AccelByteUe4Sdk/Private/GameServerApi/AccelByteServerDSMApi.cpp

@@ -282,6 +282,49 @@ void ServerDSM::GetServerInfo(const THandler<FAccelByteModelsServerInfo>& OnSucc
 	}
 }
 
+void ServerDSM::GetSessionTimeout(const THandler<FAccelByteModelsServerTimeoutResponse>& OnSuccess, const FErrorHandler& OnError)
+{
+	FReport::Log(FString(__FUNCTION__));
+
+	if (ServerType == EServerType::NONE)
+	{
+		OnError.ExecuteIfBound((int32)ErrorCodes::StatusBadRequest, TEXT("Server not Registered."));
+		return;
+	}
+	
+	const FString Url = FString::Printf(TEXT("%s/namespaces/%s/servers/%s/config/sessiontimeout")
+		, *ServerSettingsRef.DSMControllerServerUrl
+		, *ServerCredentialsRef.GetClientNamespace()
+		, *ServerName);
+
+	HttpClient.ApiRequest(TEXT("GET"), Url, {}, FString(), OnSuccess, OnError);
+	
+}
+
+void ServerDSM::ServerHeartbeat(const FVoidHandler& OnSuccess, const FErrorHandler& OnError)
+{
+	FReport::Log(FString(__FUNCTION__));
+
+	if (ServerType == EServerType::NONE)
+	{
+		OnError.ExecuteIfBound((int32)ErrorCodes::StatusBadRequest, TEXT("Server not Registered."));
+		return;
+	}
+	
+	const FString Url = FString::Printf(TEXT("%s/namespaces/%s/servers/heartbeat")
+		, *ServerSettingsRef.DSMControllerServerUrl
+		, *ServerCredentialsRef.GetClientNamespace());
+
+	FString Content = TEXT("");
+	TSharedPtr<FJsonObject> JsonObject = MakeShared<FJsonObject>();
+	JsonObject->SetStringField("podName", ServerName);
+	TSharedRef<TJsonWriter<>> Writer = TJsonWriterFactory<>::Create(&Content);
+	FJsonSerializer::Serialize(JsonObject.ToSharedRef(), Writer);
+
+	HttpClient.ApiRequest(TEXT("PUT"), Url, {}, Content, OnSuccess, OnError);
+	
+}
+
 void ServerDSM::GetSessionId(const THandler<FAccelByteModelsServerSessionResponse>& OnSuccess
 	, const FErrorHandler& OnError)
 {
@@ -338,6 +381,13 @@ bool ServerDSM::ShutdownTick(float DeltaTime)
 	return true;
 }
 
+bool ServerDSM::PeriodicHeartbeat(float DeltaTime)
+{
+	FReport::Log(FString(__FUNCTION__));
+	ServerHeartbeat(OnHeartbeatSuccess, OnHeartbeatError);
+	return true;
+}
+
 void ServerDSM::ConfigureAutoShutdown(uint32 TickSeconds
 	, int CountdownStart)
 {
@@ -395,6 +445,28 @@ void ServerDSM::ParseCommandParam()
 	}
 }
 
+void ServerDSM::SetOnHeartbeatSuccessDelegate(const FVoidHandler& OnSuccess)
+{
+	OnHeartbeatSuccess = OnSuccess;
+}
+
+void ServerDSM::SetOnHeartbeatErrorDelegate(const FErrorHandler& OnError)
+{
+	OnHeartbeatError = OnError;
+}
+
+void ServerDSM::StartHeartbeat(uint32 IntervalSeconds)
+{
+	HeartbeatTickSeconds = IntervalSeconds;
+	HeartbeatDelegate = FTickerDelegate::CreateRaw(this, &ServerDSM::PeriodicHeartbeat);
+	HeartbeatDelegateHandle = FTickerAlias::GetCoreTicker().AddTicker(HeartbeatDelegate, HeartbeatTickSeconds);
+}
+
+void ServerDSM::StopHeartbeat()
+{
+	FTickerAlias::GetCoreTicker().RemoveTicker(HeartbeatDelegateHandle);
+}
+
 int32 ServerDSM::GetPlayerNum()
 {
 	UGameEngine* GameEngine = CastChecked<UGameEngine>(GEngine);

Source/AccelByteUe4Sdk/Public/GameServerApi/AccelByteServerDSMApi.h

@@ -152,6 +152,24 @@ class ACCELBYTEUE4SDK_API ServerDSM : public FServerApiBase
 	void GetServerInfo(const THandler<FAccelByteModelsServerInfo>& OnSuccess
 		, const FErrorHandler& OnError);
 
+	/**
+	 * @brief GetServerTimeout
+	 *
+	 * @param OnSuccess This will be called when the operation succeeded.
+	 * @param OnError This will be called when the operation failed.
+	 */
+	void GetSessionTimeout(const THandler<FAccelByteModelsServerTimeoutResponse>& OnSuccess
+		, const FErrorHandler& OnError);
+
+	/**
+	 * @brief ServerHeartbeat
+	 *
+	 * @param OnSuccess This will be called when the operation succeeded.
+	 * @param OnError This will be called when the operation failed.
+	 */
+	void ServerHeartbeat(const FVoidHandler& OnSuccess
+		, const FErrorHandler& OnError);
+
 	/**
 	 * @brief Configure automatic shutdown, server will send shutdown request to DSM when there is no player on the DS for some periodical time after the DS is claimed. Must be called before calling RegisterServerToDSM or RegisterLocalServerToDSM
 	 *
@@ -175,6 +193,32 @@ class ACCELBYTEUE4SDK_API ServerDSM : public FServerApiBase
 	 */
 	void SetOnAutoShutdownErrorDelegate(const FErrorHandler& OnError);
 
+	/**
+	 * @brief Set handler delegate for OnHeartbeatSuccess event
+	 *
+	 * @param OnHeartbeatSuccess This delegate will be called if the DS heartbeat is sent
+	 */
+	void SetOnHeartbeatSuccessDelegate(const FVoidHandler& OnHeartbeatSuccess);
+
+	/**
+	 * @brief Set handler delegate for OnHeartbeatError event
+	 *
+	 * @param OnHeartbeatError This delegate will be called if the DS heartbeat is not sent
+	 */
+	void SetOnHeartbeatErrorDelegate(const FErrorHandler& OnHeartbeatError);
+
+	/**
+	 * @brief Start sending heartbeat at interval.
+	 *
+	 * @param IntervalSeconds
+	 */
+	void StartHeartbeat(uint32 IntervalSeconds);
+
+	/**
+	 * @brief Stop Heartbeat.
+	 */
+	void StopHeartbeat();
+
 	void SetServerName(const FString Name) { ServerName = Name; };
 	void SetServerType(EServerType Type) { ServerType = Type; };
 	int32 GetPlayerNum();
@@ -194,6 +238,7 @@ class ACCELBYTEUE4SDK_API ServerDSM : public FServerApiBase
 	ServerDSM& operator=(ServerDSM &&) = delete; // Move assignment operator
 
 	bool ShutdownTick(float DeltaTime);
+	bool PeriodicHeartbeat(float DeltaTime);
 
 	FString ServerName = TEXT("");
 	FString Provider = TEXT("");
@@ -202,13 +247,18 @@ class ACCELBYTEUE4SDK_API ServerDSM : public FServerApiBase
 	EServerType ServerType = EServerType::NONE;
 	FHttpRequestCompleteDelegate OnRegisterResponse;
 	FVoidHandler OnAutoShutdown;
+	FVoidHandler OnHeartbeatSuccess;
 	bool bIsDSClaimed = false;
 	uint32 ShutdownTickSeconds = 0;
+	uint32 HeartbeatTickSeconds = 0;
 	int ShutdownCountdown = 0;
 	int CountdownTimeStart = -1;
 	FErrorHandler OnAutoShutdownError;
+	FErrorHandler OnHeartbeatError;
 	FTickerDelegate AutoShutdownDelegate;
+	FTickerDelegate HeartbeatDelegate;
 	FDelegateHandleAlias AutoShutdownDelegateHandle;
+	FDelegateHandleAlias HeartbeatDelegateHandle;
 	THandler<FAccelByteModelsPubIp> GetPubIpDelegate;
 	FAccelByteModelsServerInfo RegisteredServerInfo;
 };

Source/AccelByteUe4Sdk/Public/Models/AccelByteDSMModels.h

@@ -205,6 +205,15 @@ struct ACCELBYTEUE4SDK_API FAccelByteModelsServerSessionResponse
 	FString Session_id{};
 };
 
+USTRUCT(BlueprintType)
+struct ACCELBYTEUE4SDK_API FAccelByteModelsServerTimeoutResponse
+{
+	GENERATED_BODY()
+
+	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "AccelByte | Server | DSM | Models | ServerTimeoutResponse")
+	int32 Session_timeout{};
+};
+
 USTRUCT(BlueprintType)
 struct ACCELBYTEUE4SDK_API FAccelByteModelsServerCreateSessionRequest
 {

version.json

@@ -1,3 +1,3 @@
 {
-  "version": "23.1.3"
+  "version": "23.1.4"
 }