Navigation
API > API/Runtime > API/Runtime/MessagingRpc
Implements an RPC server.
| Name | FMessageRpcServer |
| Type | class |
| Header File | /Engine/Source/Runtime/MessagingRpc/Public/MessageRpcServer.h |
| Include Path | #include "MessageRpcServer.h" |
Syntax
class FMessageRpcServer : public IMessageRpcServer
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default constructor. | MessageRpcServer.h | ||
FMessageRpcServer
(
FMessageEndpointBuilder&& InEndpointBuilder |
MessageRpcServer.h | ||
FMessageRpcServer
(
const FString& InDebugName, |
MessageRpcServer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FMessageRpcServer() |
Virtual destructor. | MessageRpcServer.h |
Structs
| Name | Remarks |
|---|---|
| FReturnInfo |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bSendProgress | bool | If the server sends progress updates. | MessageRpcServer.h | |
| Handlers | TMap< FTopLevelAssetPath, TSharedPtr< IMessageRpcHandler > > | Registered request message handlers. | MessageRpcServer.h | |
| NoHandlerDelegate | PRAGMA_DISABLE_DEPRECATION_WARNINGSFOnMessageRpcNoHandler | Delegate that is executed when a received RPC message has no registered handler. | MessageRpcServer.h | |
| NoHandlerDelegateWithPathName | FOnMessagePathNameRpcNoHandler | Delegate that is executed when a received RPC message has no registered handler. | MessageRpcServer.h | |
| Returns | TMap< FGuid, FReturnInfo > | Collection of pending RPC returns. | MessageRpcServer.h | |
| TickerHandle | FTSTicker::FDelegateHandle | Handle to the registered ticker. | MessageRpcServer.h |
Functions
Public
Overridden from IMessageRpcServer
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddHandler
(
const FTopLevelAssetPath& RequestMessageType, |
Add an RPC request handler. | MessageRpcServer.h | |
virtual const FMessageAddress & GetAddress() |
Gets the server's message address. | MessageRpcServer.h | |
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSFOnMessageRpcNoHandler & OnNoHandler() |
Get a delegate that is executed when a received RPC message has no registered handler. | MessageRpcServer.h | |
virtual FOnMessagePathNameRpcNoHandler & OnNoHandlerWithPathName() |
Get a delegate that is executed when a received RPC message has no registered handler. | MessageRpcServer.h | |
virtual void SetSendProgressUpdate
(
bool InSendProgress |
Set if the server sends progress updates | MessageRpcServer.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FMessageEndpoint, ESPMode::ThreadSafe > GetEndpoint() |
MessageRpcServer.h | ||
void ProcessCancelation
(
const FMessageRpcCancel& Message, |
Processes an FMessageRpcCancel message. | MessageRpcServer.h | |
void ProcessRequest
(
const TSharedRef< IMessageContext, ESPMode::ThreadSafe >& Context |
Processes an RPC request message. | MessageRpcServer.h | |
void SendProgress
(
const FGuid& CallId, |
Send a progress message to the RPC client that made the RPC call. | MessageRpcServer.h | |
void SendResult
(
const FGuid& CallId, |
Send a result message to the RPC client that made the RPC call. | MessageRpcServer.h |