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

#include <IMessageRpcServer.h>

+ Inheritance diagram for IMessageRpcServer:

Public Member Functions

void AddHandler (const FName &RequestMessageType, const TSharedRef< IMessageRpcHandler > &Handler)
 
virtual void AddHandler (const FTopLevelAssetPath &RequestMessageType, const TSharedRef< IMessageRpcHandler > &Handler)=0
 
virtual const FMessageAddressGetAddress () const =0
 
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS FOnMessageRpcNoHandlerOnNoHandler ()=0
 
virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS FOnMessagePathNameRpcNoHandlerOnNoHandlerWithPathName ()=0
 
virtual void SetSendProgressUpdate (bool InSendProgress)=0
 
template<typename RpcType , typename HandlerType >
void RegisterHandler (HandlerType *Handler, typename THandler< RpcType, HandlerType >::FuncType Func)
 
virtual ~IMessageRpcServer ()
 

Detailed Description

Interface for RPC servers.

Constructor & Destructor Documentation

◆ ~IMessageRpcServer()

virtual IMessageRpcServer::~IMessageRpcServer ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ AddHandler() [1/2]

void IMessageRpcServer::AddHandler ( const FName RequestMessageType,
const TSharedRef< IMessageRpcHandler > &  Handler 
)
inline

Add an RPC request handler.

Parameters
HandlerThe handler to add.

◆ AddHandler() [2/2]

virtual void IMessageRpcServer::AddHandler ( const FTopLevelAssetPath RequestMessageType,
const TSharedRef< IMessageRpcHandler > &  Handler 
)
pure virtual

Add an RPC request handler.

Parameters
HandlerThe handler to add.

Implemented in FMessageRpcServer.

◆ GetAddress()

virtual const FMessageAddress & IMessageRpcServer::GetAddress ( ) const
pure virtual

Gets the server's message address.

Returns
Message address.

Implemented in FMessageRpcServer.

◆ OnNoHandler()

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS FOnMessageRpcNoHandler & IMessageRpcServer::OnNoHandler ( )
pure virtual

Get a delegate that is executed when a received RPC message has no registered handler.

Returns
The delegate.

Implemented in FMessageRpcServer.

◆ OnNoHandlerWithPathName()

virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS FOnMessagePathNameRpcNoHandler & IMessageRpcServer::OnNoHandlerWithPathName ( )
pure virtual

Get a delegate that is executed when a received RPC message has no registered handler.

Returns
The delegate.

Implemented in FMessageRpcServer.

◆ RegisterHandler()

void IMessageRpcServer::RegisterHandler ( HandlerType Handler,
typename THandler< RpcType, HandlerType >::FuncType  Func 
)
inline

Register an RPC request handler.

Parameters
HandlerThe object that will handle the requests.
HandlerFuncThe object's request handling function.

◆ SetSendProgressUpdate()

virtual void IMessageRpcServer::SetSendProgressUpdate ( bool  InSendProgress)
pure virtual

Set if the server sends progress updates

Parameters
InSendProgressif the server send rpc progress update

Implemented in FMessageRpcServer.


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