Skip to content

Class IProtobufBackend

Class IProtobufBackend

Defined in File ProtobufBackend.h

Inheritance Relationships

Derived Types

public IConsumerBackend< RequestType > (Template Class IConsumerBackend)
public IConsumerBackend< GymConnectorStartRequest > (Template Class IConsumerBackend)
public IConsumerBackend< ImitationConnectorStartRequest > (Template Class IConsumerBackend)
public IExchangeBackend< RequestType, ResponseType > (Template Class IExchangeBackend)
public IExchangeBackend< Schola::StateUpdate, Schola::State > (Template Class IExchangeBackend)
public IProducerBackend< ResponseType > (Template Class IProducerBackend)
public IProducerBackend< Schola::TrainingDefinition > (Template Class IProducerBackend)
public IProducerBackend< Schola::ImitationState > (Template Class IProducerBackend)
public IConsumerBackend< T > (Template Class IConsumerBackend)
public IExchangeBackend< In, Out > (Template Class IExchangeBackend)
public IProducerBackend< T > (Template Class IProducerBackend)

class IProtobufBackend

Source: Source/Schola/Protobuf/Public/ProtobufBackends/ProtobufBackend.h 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 >

Public Functions

Symbol	Details
`~IProtobufBackend`	Empty Desctructor explicitly defined to avoid C4265.
`Initialize`	Perform any setup that happens prior to establishing any external connection.
`Establish`	Perform any setup that involves handshakes with the external communication (e.g.
`Shutdown`	Close the external connection.
`Restart`	Reset the Communication backend.
`Start`	—

`~IProtobufBackend`

inline virtual ~IProtobufBackend()

Empty Desctructor explicitly defined to avoid C4265.

Attributes: inline, virtual

Source: Source/Schola/Protobuf/Public/ProtobufBackends/ProtobufBackend.h

Initialize

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: Source/Schola/Protobuf/Public/ProtobufBackends/ProtobufBackend.h

Establish

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: Source/Schola/Protobuf/Public/ProtobufBackends/ProtobufBackend.h

Shutdown

virtual void Shutdown() = 0

Close the external connection.

Attributes: pure virtual

Source: Source/Schola/Protobuf/Public/ProtobufBackends/ProtobufBackend.h

Restart

virtual void Restart() = 0

Reset the Communication backend.

Attributes: pure virtual

Source: Source/Schola/Protobuf/Public/ProtobufBackends/ProtobufBackend.h

Start

virtual void Start() = 0

Attributes: pure virtual

Source: Source/Schola/Protobuf/Public/ProtobufBackends/ProtobufBackend.h