UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IMessageRpcClient Class Referenceabstract

#include <IMessageRpcClient.h>

+ Inheritance diagram for IMessageRpcClient:

Public Member Functions

virtual void Connect (const FMessageAddress &InServerAddress)=0
 
virtual void Disconnect ()=0
 
virtual bool IsConnected () const =0
 
template<typename RpcType , typename... P>
TAsyncResult< typename RpcType::FResult > Call (P... Params)
 
virtual ~IMessageRpcClient ()
 

Protected Member Functions

virtual void AddCall (const TSharedRef< IMessageRpcCall > &Call)=0
 
virtual void CancelCall (const FGuid &CallId)=0
 

Detailed Description

Interface for RPC clients.

Constructor & Destructor Documentation

◆ ~IMessageRpcClient()

virtual IMessageRpcClient::~IMessageRpcClient ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ AddCall()

virtual void IMessageRpcClient::AddCall ( const TSharedRef< IMessageRpcCall > &  Call)
protectedpure virtual

Add an RPC request.

Parameters
RequestThe call to add.

Implemented in FMessageRpcClient.

◆ Call()

template<typename RpcType , typename... P>
TAsyncResult< typename RpcType::FResult > IMessageRpcClient::Call ( P...  Params)
inline

Call a remote procedure.

Parameters
RpcTypeThe RPC type definition.
PThe call parameter types.
ParamsThe call parameter list.

◆ CancelCall()

virtual void IMessageRpcClient::CancelCall ( const FGuid CallId)
protectedpure virtual

Cancel the specified RPC call.

Parameters
CallIdThe unique identifier of the call to cancel.

Implemented in FMessageRpcClient.

◆ Connect()

virtual void IMessageRpcClient::Connect ( const FMessageAddress InServerAddress)
pure virtual

Connect this client to an RPC server.

Parameters
InServerAddressThe RPC server's message address.
See also
Disconnect

Implemented in FMessageRpcClient.

◆ Disconnect()

virtual void IMessageRpcClient::Disconnect ( )
pure virtual

Disconnect this client from the RPC server.

See also
Connect

Implemented in FMessageRpcClient.

◆ IsConnected()

virtual bool IMessageRpcClient::IsConnected ( ) const
pure virtual

Whether the MessageRpcClient is currently connected to an RPC server.

Returns
true if the client is connected, false otherwise.

Implemented in FMessageRpcClient.


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