F´ Flight Software - C/C++ Documentation NASA-v1.6.0
A framework for building embedded system applications to NASA flight quality standards.
Loading...
Searching...
No Matches
Svc::BufferRepeater Class Reference

#include <Svc/BufferRepeater/BufferRepeater.hpp>

Inheritance diagram for Svc::BufferRepeater:

Public Types

enum  BufferRepeaterFailureOption { NO_RESPONSE_ON_OUT_OF_MEMORY , WARNING_ON_OUT_OF_MEMORY , FATAL_ON_OUT_OF_MEMORY , NUM_BUFFER_REPEATER_FAILURE_OPTIONS }
 

Public Member Functions

 BufferRepeater (const char *const compName)
 
void init (const NATIVE_INT_TYPE instance=0)
 
 ~BufferRepeater ()
 
void configure (BufferRepeaterFailureOption allocation_failure_response)
 

Detailed Description

Definition at line 20 of file BufferRepeater.hpp.

Member Enumeration Documentation

◆ BufferRepeaterFailureOption

Set of responses to failures to allocate a buffer when requested

Enumerator
NO_RESPONSE_ON_OUT_OF_MEMORY 

The component will continue regardless of allocation failures

WARNING_ON_OUT_OF_MEMORY 

The component will produce a warning on allocation failures

FATAL_ON_OUT_OF_MEMORY 

The component will produce a FATAL on allocation failures

NUM_BUFFER_REPEATER_FAILURE_OPTIONS 

Maximum value of this setting. Used to mark as uninitialized.

Definition at line 25 of file BufferRepeater.hpp.

Constructor & Destructor Documentation

◆ BufferRepeater()

Svc::BufferRepeater::BufferRepeater ( const char *const  compName)

Construct object BufferRepeater

Parameters
compNameThe component name

Definition at line 22 of file BufferRepeater.cpp.

◆ ~BufferRepeater()

Svc::BufferRepeater::~BufferRepeater ( )

Destroy object BufferRepeater

Definition at line 30 of file BufferRepeater.cpp.

Member Function Documentation

◆ configure()

void Svc::BufferRepeater::configure ( BufferRepeater::BufferRepeaterFailureOption  allocation_failure_response)

Set the response used when an allocation request fails to produce a buffer. By default this will assert.

Parameters
allocation_failure_responseset response

Definition at line 32 of file BufferRepeater.cpp.

◆ init()

void Svc::BufferRepeater::init ( const NATIVE_INT_TYPE  instance = 0)

Initialize object BufferRepeater

Parameters
instanceThe instance number

Definition at line 26 of file BufferRepeater.cpp.


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