IMessageRpcCall Class Reference

#include <IMessageRpcCall.h>

Public Member Functions
virtual void	Complete (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &ResponseContext)=0
virtual const FGuid &	GetId () const =0
virtual void *	GetMessageTemplate () const =0
virtual void *	ConstructMessage () const =0
virtual FDateTime	GetLastUpdated () const =0
virtual UScriptStruct *	GetMessageType () const =0
virtual FDateTime	GetTimeCreated () const =0
virtual void	TimeOut ()=0
virtual void	UpdateProgress (float InCompletion, const FText &InStatusText)=0
virtual	~IMessageRpcCall ()

Detailed Description

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.

Constructor & Destructor Documentation

~IMessageRpcCall()

virtual IMessageRpcCall::~IMessageRpcCall ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

Complete()

virtual void IMessageRpcCall::Complete ( const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &  ResponseContext )

pure virtual

Complete the request and set its result, if available.

Parameters

ResponseContext

The context of the response message.

See also

TimeOut

ConstructMessage()

virtual void * IMessageRpcCall::ConstructMessage ( ) const

pure virtual

Constructs a new message based on the call message template. Ownership of the message belongs to the caller.

Returns

Pointer to the request message.

GetId()

virtual const FGuid & IMessageRpcCall::GetId ( ) const

pure virtual

Get the call's unique identifier.

Returns

Call identifier.

GetLastUpdated()

virtual FDateTime IMessageRpcCall::GetLastUpdated ( ) const

pure virtual

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

Returns

Update time.

GetMessageTemplate()

virtual void * IMessageRpcCall::GetMessageTemplate ( ) const

pure virtual

Get the request message template.

Returns

Pointer to the request message template.

GetMessageType()

virtual UScriptStruct * IMessageRpcCall::GetMessageType ( ) const

pure virtual

Get the type of the request message.

Returns

Request message type.

GetTimeCreated()

virtual FDateTime IMessageRpcCall::GetTimeCreated ( ) const

pure virtual

Gets the time at which the request was created.

Returns

Creation time.

TimeOut()

virtual void IMessageRpcCall::TimeOut ( )

pure virtual

Time out the request.

See also

Complete

UpdateProgress()

virtual void IMessageRpcCall::UpdateProgress ( float  InCompletion, const FText &  InStatusText  )

pure virtual

Update the current progress.

Parameters

InCompletion	The new completion percentage.
InStatusText	The new status text.

---

The documentation for this class was generated from the following file:

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