FMessageRpcClient Class Reference

#include <MessageRpcClient.h>

Inheritance diagram for FMessageRpcClient:

Public Member Functions
	FMessageRpcClient ()
	FMessageRpcClient (const FString &InDebugName, const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &InMessageBus)
virtual	~FMessageRpcClient ()
virtual void	Connect (const FMessageAddress &InServerAddress) override
virtual void	Disconnect () override
virtual bool	IsConnected () const override
Public Member Functions inherited from IMessageRpcClient
template<typename RpcType , typename... P>
TAsyncResult< typename RpcType::FResult >	Call (P... Params)
virtual	~IMessageRpcClient ()

Protected Member Functions
	FMessageRpcClient (FMessageEndpointBuilder &&InEndpointBuilder)
TSharedPtr< IMessageRpcCall >	FindCall (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context)
void	SendCall (const TSharedPtr< IMessageRpcCall > &Call)
virtual void	AddCall (const TSharedRef< IMessageRpcCall > &Call) override
virtual void	CancelCall (const FGuid &CallId) override

Detailed Description

Implements an RPC client.

Constructor & Destructor Documentation

FMessageRpcClient() [1/3]

FMessageRpcClient::FMessageRpcClient

(

)

Default constructor.

FMessageRpcClient() [2/3]

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

~FMessageRpcClient()

FMessageRpcClient::~FMessageRpcClient ( )

virtual

Virtual destructor.

FMessageRpcClient() [3/3]

FMessageRpcClient::FMessageRpcClient ( FMessageEndpointBuilder &&  InEndpointBuilder )

explicitprotected

Member Function Documentation

AddCall()

void FMessageRpcClient::AddCall ( const TSharedRef< IMessageRpcCall > &  Call )

overrideprotectedvirtual

Add an RPC request.

Parameters

Request

The call to add.

Implements IMessageRpcClient.

CancelCall()

void FMessageRpcClient::CancelCall ( const FGuid &  CallId )

overrideprotectedvirtual

Cancel the specified RPC call.

Parameters

CallId

The unique identifier of the call to cancel.

Implements IMessageRpcClient.

Connect()

void FMessageRpcClient::Connect ( const FMessageAddress &  InServerAddress )

overridevirtual

Connect this client to an RPC server.

Parameters

InServerAddress

The RPC server's message address.

See also

Disconnect

Implements IMessageRpcClient.

Disconnect()

void FMessageRpcClient::Disconnect ( )

overridevirtual

Disconnect this client from the RPC server.

See also

Connect

Implements IMessageRpcClient.

FindCall()

TSharedPtr< IMessageRpcCall > FMessageRpcClient::FindCall ( const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &  Context )

protected

Find the active RPC call for a received message.

Parameters

Context

The context of the received message.

Returns

The matching call object, or nullptr if not found.

IsConnected()

bool FMessageRpcClient::IsConnected ( ) const

overridevirtual

Whether the MessageRpcClient is currently connected to an RPC server.

Returns

true if the client is connected, false otherwise.

Implements IMessageRpcClient.

SendCall()

void FMessageRpcClient::SendCall ( const TSharedPtr< IMessageRpcCall > &  Call )

protected

Sends an RPC call to the server.

Parameters

Call	The RPC call to make.

---

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

• Engine/Source/Runtime/MessagingRpc/Private/MessageRpcClient.h
• Engine/Source/Runtime/MessagingRpc/Private/MessageRpcClient.cpp