FMessageRpcServer

Implements an RPC server.

Windows
MacOS
Linux

Inheritance Hierarchy

IMessageRpcServer

FMessageRpcServer

References

Module

MessagingRpc

Header

/Engine/Source/Runtime/MessagingRpc/Public/MessageRpcServer.h

Include

#include "MessageRpcServer.h"

Syntax

class FMessageRpcServer : public IMessageRpcServer

Remarks

Implements an RPC server.

Variables

Name Description

Protected variable

TSharedPtr< FMe...

 

MessageEndpoint

Message endpoint.

Constructors

Name Description

Public function

FMessageRpcServer()

Default constructor.

Protected function

FMessageRpcServer

(
    FMessageEndpointBuilder&& InEndpoi...
)

Public function

FMessageRpcServer

(
    const FString& InDebugName,
    const TSharedRef< IMessageBus, ESPM...
)

Destructors

Name Description

Public function Virtual

~FMessageRpcServer()

Virtual destructor.

Functions

Name Description

Protected function Const

TSharedPtr< ...

 

GetEndpoint()

Protected function

void

 

ProcessCancelation

(
    const FMessageRpcCancel& Message,
    const TSharedRef< IMessageContext, ...
)

Processes an FMessageRpcCancel message.

Protected function

void

 

ProcessRequest

(
    const TSharedRef< IMessageContext, ...
)

Processes an RPC request message.

Protected function

void

 

SendProgress

(
    const FGuid& CallId,
    const FReturnInfo& ReturnInfo
)

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

Protected function

void

 

SendResult

(
    const FGuid& CallId,
    const FReturnInfo& ReturnInfo
)

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

Overridden from IMessageRpcServer

Name Description

Public function Virtual

void

 

AddHandler

(
    const FName& RequestMessageType,
    const TSharedRef< IMessageRpcHandle...
)

Add an RPC request handler.

Public function Virtual Const

const FMessa...

 

GetAddress()

Gets the server's message address.

Public function Virtual

FOnMessageRp...

 

OnNoHandler()

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

Public function Virtual

void

 

SetSendProgressUpdate

(
    bool InSendProgress
)

Set if the server sends progress updates

Classes

Name

Description

Protected struct

FReturnInfo

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss