UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMessagingRpcModule Class Reference
+ Inheritance diagram for FMessagingRpcModule:

Public Member Functions

virtual TSharedRef< IMessageRpcClientCreateRpcClient () override
 
virtual TSharedRef< IMessageRpcClientCreateRpcClient (const FString &DebugName, const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &MessageBus) override
 
virtual TSharedRef< IMessageRpcServerCreateRpcServer () override
 
virtual TSharedRef< IMessageRpcServerCreateRpcServer (const FString &DebugName, const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &MessageBus) override
 
virtual void StartupModule () override
 
virtual void ShutdownModule () override
 
virtual bool SupportsDynamicReloading () override
 
- Public Member Functions inherited from IMessagingRpcModule
virtual ~IMessagingRpcModule ()
 
- Public Member Functions inherited from IModuleInterface
virtual ~IModuleInterface ()
 
virtual void PreUnloadCallback ()
 
virtual void PostLoadCallback ()
 
virtual bool SupportsAutomaticShutdown ()
 
virtual bool IsGameModule () const
 

Detailed Description

Implements the MessagingRpc module.

Member Function Documentation

◆ CreateRpcClient() [1/2]

virtual TSharedRef< IMessageRpcClient > FMessagingRpcModule::CreateRpcClient ( )
inlineoverridevirtual

Create a client for remote procedure calls.

Returns
The RPC client.

Implements IMessagingRpcModule.

◆ CreateRpcClient() [2/2]

virtual TSharedRef< IMessageRpcClient > FMessagingRpcModule::CreateRpcClient ( const FString &  DebugName,
const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &  MessageBus 
)
inlineoverridevirtual

Create a client for remote procedure calls.

Parameters
DebugNameThe RPC client's endpoint debug name.
MessageBusThe RPC client's endpoint message bus.
Returns
The RPC client.

Implements IMessagingRpcModule.

◆ CreateRpcServer() [1/2]

virtual TSharedRef< IMessageRpcServer > FMessagingRpcModule::CreateRpcServer ( )
inlineoverridevirtual

Create a server for remote procedure calls.

Returns
The RPC server.

Implements IMessagingRpcModule.

◆ CreateRpcServer() [2/2]

virtual TSharedRef< IMessageRpcServer > FMessagingRpcModule::CreateRpcServer ( const FString &  DebugName,
const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &  MessageBus 
)
inlineoverridevirtual

Create a server for remote procedure calls.

Parameters
DebugNameThe RPC server's endpoint debug name.
MessageBusThe RPC server's endpoint message bus.
Returns
The RPC server.

Implements IMessagingRpcModule.

◆ ShutdownModule()

virtual void FMessagingRpcModule::ShutdownModule ( )
inlineoverridevirtual

Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finish StartupModule(). This means that, as long as a module references dependent modules in it's StartupModule(), it can safely reference those dependencies in ShutdownModule() as well.

Reimplemented from IModuleInterface.

◆ StartupModule()

virtual void FMessagingRpcModule::StartupModule ( )
inlineoverridevirtual

Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule. ie:

FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

Reimplemented from IModuleInterface.

◆ SupportsDynamicReloading()

virtual bool FMessagingRpcModule::SupportsDynamicReloading ( )
inlineoverridevirtual

Override this to set whether your module is allowed to be unloaded on the fly

Returns
Whether the module supports shutdown separate from the rest of the engine.

Reimplemented from IModuleInterface.


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