HiveMind
Public Member Functions | List of all members
IInterlocMessageHandler Class Referenceabstract

#include <IInterlocMessageHandler.h>

Inheritance diagram for IInterlocMessageHandler:
Inheritance graph
Collaboration diagram for IInterlocMessageHandler:
Collaboration graph

Public Member Functions

virtual bool processMessage ()=0
 Processes the next message in the queue. More...
 
virtual bool getDumpEnabled () const =0
 Retrieves a flag to know if data dumps to the host should be done or not. More...
 
virtual bool sendInterlocDump (InterlocUpdate *updatesHistory, uint8_t updatesLength)=0
 Sends a history of interloc updates back to the host. More...
 

Member Function Documentation

◆ getDumpEnabled()

virtual bool IInterlocMessageHandler::getDumpEnabled ( ) const
pure virtual

Retrieves a flag to know if data dumps to the host should be done or not.

Returns
True if enabled, false otherwise.

Implemented in InterlocMessageHandler.

Here is the caller graph for this function:

◆ processMessage()

virtual bool IInterlocMessageHandler::processMessage ( )
pure virtual

Processes the next message in the queue.

Returns
True if successfully processed, false otherwise

Implemented in InterlocMessageHandler.

Here is the caller graph for this function:

◆ sendInterlocDump()

virtual bool IInterlocMessageHandler::sendInterlocDump ( InterlocUpdate updatesHistory,
uint8_t  updatesLength 
)
pure virtual

Sends a history of interloc updates back to the host.

Parameters
updatesHistoryPointer to an array of interlocUpdates
updatesLengthNumber of items in the array
Returns
True if message was queued for send, false otherwise

Implemented in InterlocMessageHandler.

Here is the caller graph for this function:

The documentation for this class was generated from the following file: