mirror of
https://github.com/nasa/fprime.git
synced 2025-12-11 13:54:34 -06:00
c69ff72110
* Format Svc and add to CI * Fix comlogger include * fix assert UTs * Fix static analysis warning * formatting
47 lines
1.4 KiB
C++
47 lines
1.4 KiB
C++
// ======================================================================
|
|
// \title DeframingProtocolInterface.hpp
|
|
// \author mstarch
|
|
// \brief hpp file for deframing protocol interface
|
|
//
|
|
// \copyright
|
|
// Copyright 2009-2021, by the California Institute of Technology.
|
|
// ALL RIGHTS RESERVED. United States Government Sponsorship
|
|
// acknowledged.
|
|
//
|
|
// ======================================================================
|
|
|
|
#ifndef SVC_DEFRAMING_PROTOCOL_INTERFACE_HPP
|
|
#define SVC_DEFRAMING_PROTOCOL_INTERFACE_HPP
|
|
|
|
#include <Fw/Buffer/Buffer.hpp>
|
|
#include <Fw/Time/Time.hpp>
|
|
|
|
namespace Svc {
|
|
|
|
/**
|
|
* \brief interface supplied to the deframing protocol
|
|
*
|
|
* In order to supply necessary fprime actions to deframing implementations this class provides
|
|
* the necessary functions. Typically the DeframerComponentImpl is the concrete implementor of this
|
|
* interface.
|
|
*/
|
|
class DeframingProtocolInterface {
|
|
public:
|
|
virtual ~DeframingProtocolInterface() {};
|
|
/**
|
|
* \brief called to allocate memory, typically delegating to an allocate port call
|
|
* \param size: size of the allocation request
|
|
* \return Fw::Buffer wrapping allocated memory
|
|
*/
|
|
virtual Fw::Buffer allocate(const U32 size) = 0;
|
|
|
|
/**
|
|
* \brief send deframed data into the system
|
|
* \param data: deframed buffer
|
|
*/
|
|
virtual void route(Fw::Buffer& data) = 0;
|
|
};
|
|
|
|
} // namespace Svc
|
|
#endif // SVC_DEFRAMING_PROTOCOL_INTERFACE_HPP
|