Skip to content

IProtobufBackend

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

Subclassed by IConsumerBackend< RequestType >, IConsumerBackend< GymConnectorStartRequest >, IConsumerBackend< ImitationConnectorStartRequest >, IExchangeBackend< RequestType, ResponseType >, IExchangeBackend< Schola::StateUpdate, Schola::State >, IProducerBackend< ResponseType >, IProducerBackend< Schola::TrainingDefinition >, IProducerBackend< Schola::ImitationState >, IConsumerBackend< T >, IExchangeBackend< In, Out >, IProducerBackend< T >

class IProtobufBackend

Methods

IProtobufBackend

inline virtual ~IProtobufBackend()

Empty Desctructor explicitly defined to avoid C4265.


Initialize

virtual void Initialize() = 0

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


Establish

virtual void Establish() = 0

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


Shutdown

virtual void Shutdown() = 0

Close the external connection.


Restart

virtual void Restart() = 0

Reset the Communication backend.


Start

virtual void Start() = 0

Begin serving or polling after Initialize and Establish have completed.

Source: Source/ScholaProtobuf/Public/ProtobufBackends/ProtobufBackend.h