Navigation
API > API/Runtime > API/Runtime/MessagingRpc
Interface for RPC calls.
Every time an RPC call is made, a request message containing the call parameters is sent to the remote endpoint. While the remote endpoint is executing the call, it may send back progress updates in regular intervals. Once the call is complete, the remote endpoint sends a response message containing the result.
| Name | IMessageRpcCall |
| Type | class |
| Header File | /Engine/Source/Runtime/MessagingRpc/Public/IMessageRpcCall.h |
| Include Path | #include "IMessageRpcCall.h" |
Syntax
class IMessageRpcCall
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IMessageRpcCall() |
Virtual destructor. | IMessageRpcCall.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Complete
(
const TSharedRef< IMessageContext, ESPMode::ThreadSafe >& ResponseContext |
Complete the request and set its result, if available. | IMessageRpcCall.h | |
void * ConstructMessage () |
Constructs a new message based on the call message template. | IMessageRpcCall.h | |
const FGuid & GetId() |
Get the call's unique identifier. | IMessageRpcCall.h | |
FDateTime GetLastUpdated() |
Get the time at which the request was last updated by the server. | IMessageRpcCall.h | |
void * GetMessageTemplate() |
Get the request message template. | IMessageRpcCall.h | |
UScriptStruct * GetMessageType() |
Get the type of the request message. | IMessageRpcCall.h | |
FDateTime GetTimeCreated() |
Gets the time at which the request was created. | IMessageRpcCall.h | |
void TimeOut () |
Time out the request. | IMessageRpcCall.h | |
void UpdateProgress
(
float InCompletion, |
Update the current progress. | IMessageRpcCall.h |