IMessageRpcCall

Interface for RPC calls.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IMessageRpcCall

IMessageRpcClient::FCall

References

Module

MessagingRpc

Header

/Engine/Source/Runtime/MessagingRpc/Public/IMessageRpcCall.h

Include

#include "IMessageRpcCall.h"

Syntax

class IMessageRpcCall

Remarks

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.

Destructors

Name Description

Public function Virtual

~IMessageRpcCall()

Virtual destructor.

Functions

Name Description

Public function

void

 

Complete

(
    const TSharedRef< IMessageContext, ...
)

Complete the request and set its result, if available.

Public function Const

void *

 

ConstructMessage()

Constructs a new message based on the call message template.

Public function Const

const FGuid ...

 

GetId()

Get the call's unique identifier.

Public function Const

FDateTime

 

GetLastUpdated()

Get the time at which the request was last updated by the server.

Public function Const

void *

 

GetMessageTemplate()

Get the request message template.

Public function Const

UScriptStruc...

 

GetMessageType()

Get the type of the request message.

Public function Const

FDateTime

 

GetTimeCreated()

Gets the time at which the request was created.

Public function

void

 

TimeOut()

Time out the request.

Public function

void

 

UpdateProgress

(
    float InCompletion,
    const FText& InStatusText
)

Update the current progress.