Class 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< TrainingStateUpdate, TrainingState >, IPollingBackendInterface< RequestType >, IPollingBackendInterface< GymConnectorStartRequest >, IProducerBackendInterface< ResponseType >, IProducerBackendInterface< TrainingDefinition >, IProducerBackendInterface< InitialTrainingState >, IExchangeBackendInterface< In, Out >, IPollingBackendInterface< T >, IProducerBackendInterface< T >

Public Functions

inline virtual ~IComBackendInterface()

Empty Desctructor explicitly defined to avoid C4265.

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.

virtual void Establish() = 0

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

setting up serialization). Use after Initialize.

virtual void Shutdown() = 0

Close the external connection.

virtual void Restart() = 0

Reset the Communication backend.

virtual void Start() = 0