modm API documentation

Postman interface. More...

#include <modm/communication/xpcc/postman/postman.hpp>

Inheritance diagram for xpcc::Postman:
FakePostman xpcc::DynamicPostman

Public Types

enum  DeliverInfo {
  OK = 0, ERROR, NO_COMPONENT, NO_ACTION,
  WRONG_ACTION_PARAMETER, NO_EVENT, WRONG_EVENT_PARAMETER, NOT_IMPLEMENTED_YET_ERROR
}
 

Public Member Functions

virtual DeliverInfo deliverPacket (const Header &header, const modm::SmartPointer &payload) = 0
 
virtual bool isComponentAvailable (uint8_t component) const = 0
 Check if a component is available on this board. More...
 

Detailed Description

Postman interface.

The Postman class is responsible of delivering messages the the components.

Member Function Documentation

virtual bool xpcc::Postman::isComponentAvailable ( uint8_t  component) const
pure virtual

Check if a component is available on this board.

Parameters
componentId of the component
Returns
true if the postman is available to delivier messages to the given component, false otherwise.

Implemented in xpcc::DynamicPostman, and FakePostman.


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