IComBackendInterface

class IComBackendInterface

An abstracted communication backend that can send string/byte messages and can either be polled for responses or do exchanges when it sends messages.

Note: This isn’t a UE interface because those don’t have typical Object Oriented interface functionality which we want here

Subclassed by: IExchangeBackendInterface<RequestType, ResponseType>, IExchangeBackendInterface<Schola::TrainingStateUpdate, Schola::TrainingState>, IPollingBackendInterface<RequestType>, IPollingBackendInterface<GymConnectorStartRequest>, IProducerBackendInterface<ResponseType>, IProducerBackendInterface<Schola::TrainingDefinition>, IProducerBackendInterface<InitialTrainingState>, IExchangeBackendInterface<In, Out>, IPollingBackendInterface<T>, IProducerBackendInterface<T>

Public Interface

Destructor:

~IComBackendInterface

inline virtual ~IComBackendInterface()

Empty Desctructor explicitly defined to avoid C4265.

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/Communicator/ComBackendInterface.h (line 21, column 9)

Public Functions:

Initialize

pure-virtual void Initialize()=0

Perform any setup that happens prior to establishing any external connection.

this could include opening a socket and waiting for a connection.

Attributes: pure-virtual

Source: Schola/Source/Schola/Public/Communicator/ComBackendInterface.h (line 27, column 14)

Establish

pure-virtual void Establish()=0

Perform any setup that involves handshakes with the external communication (e.g.

setting up serialization). Use after Initialize.

Attributes: pure-virtual

Source: Schola/Source/Schola/Public/Communicator/ComBackendInterface.h (line 33, column 14)

Shutdown

pure-virtual void Shutdown()=0

Close the external connection.

Attributes: pure-virtual

Source: Schola/Source/Schola/Public/Communicator/ComBackendInterface.h (line 38, column 14)

Restart

pure-virtual void Restart()=0

Reset the Communication backend.

Attributes: pure-virtual

Source: Schola/Source/Schola/Public/Communicator/ComBackendInterface.h (line 43, column 14)

Start

pure-virtual void Start()=0

Attributes: pure-virtual

Source: Schola/Source/Schola/Public/Communicator/ComBackendInterface.h (line 45, column 14)

Used By: IExchangeBackendInterface, IPollingBackendInterface, IProducerBackendInterface

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