FMessageRpcServer Class Reference

#include <MessageRpcServer.h>

Inheritance diagram for FMessageRpcServer:

Classes
struct	FReturnInfo

Public Member Functions
MESSAGINGRPC_API	FMessageRpcServer ()
MESSAGINGRPC_API	FMessageRpcServer (const FString &InDebugName, const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &InMessageBus)
virtual MESSAGINGRPC_API	~FMessageRpcServer ()
virtual MESSAGINGRPC_API void	AddHandler (const FTopLevelAssetPath &RequestMessageType, const TSharedRef< IMessageRpcHandler > &Handler) override
virtual MESSAGINGRPC_API const FMessageAddress &	GetAddress () const override
MESSAGINGRPC_API virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS FOnMessageRpcNoHandler &	OnNoHandler () override
MESSAGINGRPC_API virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS FOnMessagePathNameRpcNoHandler &	OnNoHandlerWithPathName () override
virtual MESSAGINGRPC_API void	SetSendProgressUpdate (bool InSendProgress) override
Public Member Functions inherited from IMessageRpcServer
void	AddHandler (const FName &RequestMessageType, const TSharedRef< IMessageRpcHandler > &Handler)
template<typename RpcType , typename HandlerType >
void	RegisterHandler (HandlerType *Handler, typename THandler< RpcType, HandlerType >::FuncType Func)
virtual	~IMessageRpcServer ()

Protected Member Functions
MESSAGINGRPC_API	FMessageRpcServer (FMessageEndpointBuilder &&InEndpointBuilder)
MESSAGINGRPC_API TSharedPtr< FMessageEndpoint, ESPMode::ThreadSafe >	GetEndpoint () const
MESSAGINGRPC_API void	ProcessCancelation (const FMessageRpcCancel &Message, const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context)
MESSAGINGRPC_API void	ProcessRequest (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context)
MESSAGINGRPC_API void	SendProgress (const FGuid &CallId, const FReturnInfo &ReturnInfo)
MESSAGINGRPC_API void	SendResult (const FGuid &CallId, const FReturnInfo &ReturnInfo)

Protected Attributes
TSharedPtr< FMessageEndpoint, ESPMode::ThreadSafe >	MessageEndpoint

Detailed Description

Implements an RPC server.

Constructor & Destructor Documentation

FMessageRpcServer() [1/3]

FMessageRpcServer::FMessageRpcServer

(

)

Default constructor.

FMessageRpcServer() [2/3]

FMessageRpcServer::FMessageRpcServer	(	const FString &	InDebugName,
		const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &	InMessageBus
	)

~FMessageRpcServer()

FMessageRpcServer::~FMessageRpcServer ( )

virtual

Virtual destructor.

FMessageRpcServer() [3/3]

FMessageRpcServer::FMessageRpcServer ( FMessageEndpointBuilder &&  InEndpointBuilder )

explicitprotected

Member Function Documentation

AddHandler()

void FMessageRpcServer::AddHandler ( const FTopLevelAssetPath &  RequestMessageType, const TSharedRef< IMessageRpcHandler > &  Handler  )

overridevirtual

Add an RPC request handler.

Parameters

Handler

The handler to add.

Implements IMessageRpcServer.

GetAddress()

const FMessageAddress & FMessageRpcServer::GetAddress ( ) const

overridevirtual

Gets the server's message address.

Returns

Message address.

Implements IMessageRpcServer.

GetEndpoint()

TSharedPtr< FMessageEndpoint, ESPMode::ThreadSafe > FMessageRpcServer::GetEndpoint ( ) const

protected

OnNoHandler()

PRAGMA_DISABLE_DEPRECATION_WARNINGS FOnMessageRpcNoHandler & FMessageRpcServer::OnNoHandler ( )

overridevirtual

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

Returns

The delegate.

Implements IMessageRpcServer.

OnNoHandlerWithPathName()

PRAGMA_ENABLE_DEPRECATION_WARNINGS FOnMessagePathNameRpcNoHandler & FMessageRpcServer::OnNoHandlerWithPathName ( )

overridevirtual

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

Returns

The delegate.

Implements IMessageRpcServer.

ProcessCancelation()

void FMessageRpcServer::ProcessCancelation ( const FMessageRpcCancel &  Message, const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &  Context  )

protected

Processes an FMessageRpcCancel message.

ProcessRequest()

void FMessageRpcServer::ProcessRequest ( const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &  Context )

protected

Processes an RPC request message.

SendProgress()

void FMessageRpcServer::SendProgress ( const FGuid &  CallId, const FReturnInfo &  ReturnInfo  )

protected

Send a progress message to the RPC client that made the RPC call.

SendResult()

void FMessageRpcServer::SendResult ( const FGuid &  CallId, const FReturnInfo &  ReturnInfo  )

protected

Send a result message to the RPC client that made the RPC call.

SetSendProgressUpdate()

void FMessageRpcServer::SetSendProgressUpdate ( bool  InSendProgress )

overridevirtual

Set if the server sends progress updates

Parameters

InSendProgress

if the server send rpc progress update

Implements IMessageRpcServer.

Member Data Documentation

MessageEndpoint

TSharedPtr<FMessageEndpoint, ESPMode::ThreadSafe> FMessageRpcServer::MessageEndpoint

protected

Message endpoint.

---

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

• Engine/Source/Runtime/MessagingRpc/Public/MessageRpcServer.h
• Engine/Source/Runtime/MessagingRpc/Private/MessageRpcServer.cpp