F´ Flight Software - C/C++ Documentation  NASA-v2.0.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Svc::FprimeDeframing Class Reference

#include <Svc/FramingProtocol/FprimeProtocol.hpp>

Inheritance diagram for Svc::FprimeDeframing:
Svc::DeframingProtocol

Public Member Functions

 FprimeDeframing ()
 
bool validate (Types::CircularBuffer &buffer, U32 size)
 
DeframingStatus deframe (Types::CircularBuffer &buffer, U32 &needed)
 
- Public Member Functions inherited from Svc::DeframingProtocol
 DeframingProtocol ()
 
void setup (DeframingProtocolInterface &interface)
 

Additional Inherited Members

- Public Types inherited from Svc::DeframingProtocol
enum  DeframingStatus {
  DEFRAMING_STATUS_SUCCESS, DEFRAMING_INVALID_SIZE, DEFRAMING_INVALID_CHECKSUM, DEFRAMING_MORE_NEEDED,
  DEFRAMING_MAX_STATUS
}
 Status of the deframing call. More...
 
- Protected Attributes inherited from Svc::DeframingProtocol
DeframingProtocolInterfacem_interface
 

Detailed Description

Definition at line 33 of file FprimeProtocol.hpp.

Constructor & Destructor Documentation

◆ FprimeDeframing()

Svc::FprimeDeframing::FprimeDeframing ( )

Definition at line 22 of file FprimeProtocol.cpp.

Member Function Documentation

◆ deframe()

DeframingProtocol::DeframingStatus Svc::FprimeDeframing::deframe ( Types::CircularBuffer buffer,
U32 &  needed 
)
virtual

Deframe packets from within the circular buffer

Returns
deframing status of this deframe attempt
Parameters
bufferDeframe from circular buffer
neededReturn needed number of bytes

Implements Svc::DeframingProtocol.

Definition at line 84 of file FprimeProtocol.cpp.

◆ validate()

bool Svc::FprimeDeframing::validate ( Types::CircularBuffer buffer,
U32  size 
)

Definition at line 61 of file FprimeProtocol.cpp.


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