Skip to content

IPollingBackendInterface

template<typename T>
class IPollingBackendInterface : public IComBackendInterface

A Generic Interface for any service that can be used to receive messages of type T asynchronously via polling.

Template Parameters: typename T

Dependencies: IComBackendInterface

Inherits from: public IComBackendInterface

Public Interface

Public Functions:

Poll

pure-virtual TOptional<const T *> Poll()=0

Poll the Backend for a message from the client.

Returns: An Empty optional if No messages have been received, a fulfilled one otherwise

Note: This function should be non-blocking

Returns: TOptional&lt;const T &#42;&gt;

Attributes: pure-virtual

Source: Schola/Source/Schola/Public/Communicator/ComBackendInterface.h (line 63, column 19)

PollAndDeserialize

inline TOptional<UnrealType *> PollAndDeserialize()

Poll the Backend for a message from the client and deserialize it into the specified type.

Returns: An Empty optional if No messages have been received, a fulfilled one otherwise

Returns: TOptional&lt;UnrealType &#42;&gt;

Attributes: inline

Source: Schola/Source/Schola/Public/Communicator/ComBackendInterface.h (line 71, column 11)

Used By: PollingRPCBackend, UCommunicationManager, UPythonGymConnector

Source: Schola/Source/Schola/Public/Communicator/ComBackendInterface.h (line 54, column 1)