You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
d1443992e1
This change consists of multiple changes: Core: - Deprecation of ANY_PACKAGE macro. Added ANY_PACKAGE_DEPRECATED macro which can still be used for backwards compatibility purposes (only used in CoreUObject) - Deprecation of StaticFindObjectFast* functions that take bAnyPackage parameter - Added UStruct::GetStructPathName function that returns FTopLevelAssetPath representing the path name (package + object FName, super quick compared to UObject::GetPathName) + wrapper UClass::GetClassPathName to make it look better when used with UClasses - Added (Static)FindFirstObject* functions that find a first object given its Name (no Outer). These functions are used in places I consider valid to do global UObject (UClass) lookups like parsing command line parameters / checking for unique object names - Added static UClass::TryFindType function which serves a similar purpose as FindFirstObject however it's going to throw a warning (with a callstack / maybe ensure in the future?) if short class name is provided. This function is used in places that used to use short class names but now should have been converted to use path names to catch any potential regressions and or edge cases I missed. - Added static UClass::TryConvertShortNameToPathName utility function - Added static UClass::TryFixShortClassNameExportPath utility function - Object text export paths will now also include class path (Texture2D'/Game/Textures/Grass.Grass' -> /Script/Engine.Texture2D'/Game/Textures/Grass.Grass') - All places that manually generated object export paths for objects will now use FObjectPropertyBase::GetExportPath - Added a new startup test that checks for short type names in UClass/FProperty MetaData values AssetRegistry: - Deprecated any member variables (FAssetData / FARFilter) or functions that use FNames to represent class names and replaced them with FTopLevelAssetPath - Added new member variables and new function overloads that use FTopLevelAssetPath to represent class names - This also applies to a few other modules' APIs to match AssetRegistry changes Everything else: - Updated code that used ANY_PACKAGE (depending on the use case) to use FindObject(nullptr, PathToObject), UClass::TryFindType (used when path name is expected, warns if it's a short name) or FindFirstObject (usually for finding types based on user input but there's been a few legitimate use cases not related to user input) - Updated code that used AssetRegistry API to use FTopLevelAssetPaths and USomeClass::StaticClass()->GetClassPathName() instead of GetFName() - Updated meta data and hardcoded FindObject(ANY_PACKAGE, "EEnumNameOrClassName") calls to use path names #jira UE-99463 #rb many.people [FYI] Marcus.Wassmer #preflight 629248ec2256738f75de9b32 #codereviewnumbers 20320742, 20320791, 20320799, 20320756, 20320809, 20320830, 20320840, 20320846, 20320851, 20320863, 20320780, 20320765, 20320876, 20320786 #ROBOMERGE-OWNER: robert.manuszewski #ROBOMERGE-AUTHOR: robert.manuszewski #ROBOMERGE-SOURCE: CL 20430220 via CL 20433854 via CL 20435474 via CL 20435484 #ROBOMERGE-BOT: UE5 (Release-Engine-Staging -> Main) (v949-20362246) [CL 20448496 by robert manuszewski in ue5-main branch]
110 lines
3.2 KiB
C++
110 lines
3.2 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
#pragma once
|
|
|
|
#include "CoreTypes.h"
|
|
#include "Containers/Map.h"
|
|
#include "Misc/DateTime.h"
|
|
#include "Misc/Guid.h"
|
|
#include "IMessageContext.h"
|
|
#include "IMessageRpcServer.h"
|
|
#include "Templates/SharedPointer.h"
|
|
#include "Containers/Ticker.h"
|
|
|
|
class FMessageEndpoint;
|
|
class FMessagingRpcModule;
|
|
class IAsyncProgress;
|
|
class IAsyncTask;
|
|
class IMessageBus;
|
|
class IMessageRpcHandler;
|
|
|
|
struct FMessageRpcCancel;
|
|
struct FMessageEndpointBuilder;
|
|
|
|
|
|
/**
|
|
* Implements an RPC server.
|
|
*/
|
|
class MESSAGINGRPC_API FMessageRpcServer
|
|
: public IMessageRpcServer
|
|
{
|
|
public:
|
|
/** Default constructor. */
|
|
FMessageRpcServer();
|
|
FMessageRpcServer(const FString& InDebugName, const TSharedRef<IMessageBus, ESPMode::ThreadSafe>& InMessageBus);
|
|
|
|
/** Virtual destructor. */
|
|
virtual ~FMessageRpcServer();
|
|
|
|
public:
|
|
|
|
//~ IMessageRpcServer interface
|
|
|
|
virtual void AddHandler(const FTopLevelAssetPath& RequestMessageType, const TSharedRef<IMessageRpcHandler>& Handler) override;
|
|
virtual const FMessageAddress& GetAddress() const override;
|
|
PRAGMA_DISABLE_DEPRECATION_WARNINGS
|
|
virtual FOnMessageRpcNoHandler& OnNoHandler() override;
|
|
PRAGMA_ENABLE_DEPRECATION_WARNINGS
|
|
virtual FOnMessagePathNameRpcNoHandler& OnNoHandlerWithPathName() override;
|
|
virtual void SetSendProgressUpdate(bool InSendProgress) override;
|
|
protected:
|
|
explicit FMessageRpcServer(FMessageEndpointBuilder&& InEndpointBuilder);
|
|
|
|
struct FReturnInfo
|
|
{
|
|
FMessageAddress ClientAddress;
|
|
FDateTime LastProgressSent;
|
|
TSharedPtr<IAsyncProgress> Progress;
|
|
TSharedPtr<IMessageRpcReturn> Return;
|
|
TSharedPtr<IAsyncTask> Task;
|
|
};
|
|
|
|
TSharedPtr<FMessageEndpoint, ESPMode::ThreadSafe> GetEndpoint() const;
|
|
|
|
/** Processes an FMessageRpcCancel message. */
|
|
void ProcessCancelation(const FMessageRpcCancel& Message, const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
|
|
|
|
/** Processes an RPC request message. */
|
|
void ProcessRequest(const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
|
|
|
|
/** Send a progress message to the RPC client that made the RPC call. */
|
|
void SendProgress(const FGuid& CallId, const FReturnInfo& ReturnInfo);
|
|
|
|
/** Send a result message to the RPC client that made the RPC call. */
|
|
void SendResult(const FGuid& CallId, const FReturnInfo& ReturnInfo);
|
|
|
|
protected:
|
|
|
|
/** Message endpoint. */
|
|
TSharedPtr<FMessageEndpoint, ESPMode::ThreadSafe> MessageEndpoint;
|
|
|
|
private:
|
|
|
|
/** Handles all incoming messages. */
|
|
void HandleMessage(const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
|
|
|
|
/** Handles the ticker. */
|
|
bool HandleTicker(float DeltaTime);
|
|
|
|
private:
|
|
|
|
/** Registered request message handlers. */
|
|
TMap<FTopLevelAssetPath, TSharedPtr<IMessageRpcHandler>> Handlers;
|
|
|
|
/* Delegate that is executed when a received RPC message has no registered handler. */
|
|
PRAGMA_DISABLE_DEPRECATION_WARNINGS
|
|
FOnMessageRpcNoHandler NoHandlerDelegate;
|
|
PRAGMA_ENABLE_DEPRECATION_WARNINGS
|
|
|
|
/* Delegate that is executed when a received RPC message has no registered handler. */
|
|
FOnMessagePathNameRpcNoHandler NoHandlerDelegateWithPathName;
|
|
|
|
/** Collection of pending RPC returns. */
|
|
TMap<FGuid, FReturnInfo> Returns;
|
|
|
|
/** Handle to the registered ticker. */
|
|
FTSTicker::FDelegateHandle TickerHandle;
|
|
|
|
/** If the server sends progress updates. */
|
|
bool bSendProgress = true;
|
|
};
|