Class UCommunicationManager

class UCommunicationManager : public UObject

A class that manages a gRPC server running on a specified URL.

Public Functions

bool RegisterService(std::shared_ptr<grpc::Service> Service)

Register a service with the server.

Parameters:

Service – [in] The service to register

Returns:

True if the service was registered successfully, false otherwise

std::unique_ptr<ServerCompletionQueue> GetCompletionQueue()

Get the completion queue for the server.

Returns:

The completion queue

template<typename ServiceType, typename In, typename Out>
inline IPollingBackendInterface<In> *CreatePollingBackend(AsyncRPCHandle<ServiceType, In, Out> TargetRPC, std::shared_ptr<ServiceType> Service)

Create a new Polling Backend, where Unreal Polls for messages of type In.

Template Parameters:

• ServiceType – The type of the service

• In – The type of the input message

• Out – The type of the output message

Parameters:

• TargetRPC – The RPC method to wrap

• Service – The service to attach the backend to

template<typename ServiceType, typename In, typename Out>
inline IProducerBackendInterface<Out> *CreateProducerBackend(AsyncRPCHandle<ServiceType, In, Out> TargetRPC, std::shared_ptr<ServiceType> Service)

Create a new Producer Backend, where Unreal Sends messages of type Out.

Template Parameters:

• ServiceType – The type of the service

• In – The type of the input message

• Out – The type of the output message

Parameters:

• TargetRPC – The RPC method to wrap

• Service – The service to attach the backend to

template<typename ServiceType, typename In, typename Out>
inline IExchangeBackendInterface<In, Out> *CreateExchangeBackend(AsyncRPCHandle<ServiceType, In, Out> TargetRPC, std::shared_ptr<ServiceType> Service)

Create a new Exchange Backend, where Unreal Sends messages of type Out and receives back messages of type In.

Template Parameters:

• ServiceType – The type of the service

• In – The type of the input message

• Out – The type of the output message

Parameters:

• TargetRPC – The RPC method to wrap

• Service – The service to attach the backend to

void ShutdownServer()

Shutdown the Communication manager.

Triggers OnServerShutdownDelegate

bool StartBackends()

Starts all backends created by the communication manager.

Triggers OnServerStartDelegate and OnServerReadyDelegate

~UCommunicationManager()

void Initialize()

Initialize the Communication Manager.

Sets the Port and URL for the server from the Settings Panel

Public Members

FOnServerStartSignature OnServerStartDelegate

A delegate that is called when the server starts.

FOnServerReadySignature OnServerReadyDelegate

A delegate that is called when the server is ready.

FOnServerReadySignature OnConnectionEstablishedDelegate

A delegate that is called when the server establishes a connection.

FOnServerShutdownSignature OnServerShutdownDelegate

A delegate that is called when the server shuts down.