BufferRepeater.hpp

Go to the documentation of this file.

// ======================================================================
// \title  BufferRepeater.hpp
// \author lestarch
// \brief  hpp file for GenericRepeater component implementation class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef BufferRepeater_HPP
#define BufferRepeater_HPP
 
#include "Svc/BufferRepeater/BufferRepeaterComponentAc.hpp"
 
namespace Svc {
 
class BufferRepeater : public BufferRepeaterComponentBase {
  public:
    enum BufferRepeaterFailureOption {
        NO_RESPONSE_ON_OUT_OF_MEMORY,       
        WARNING_ON_OUT_OF_MEMORY,           
        FATAL_ON_OUT_OF_MEMORY,             
        NUM_BUFFER_REPEATER_FAILURE_OPTIONS 
    };
    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------
 
    BufferRepeater(const char* const compName 
    );
 
    void init(const NATIVE_INT_TYPE instance = 0 
    );
 
    ~BufferRepeater();
 
    void configure(BufferRepeaterFailureOption allocation_failure_response);
 
  private:
    // ----------------------------------------------------------------------
    // Helper functions
    // ----------------------------------------------------------------------
 
    bool check_allocation(FwIndexType index, const Fw::Buffer& new_allocation, const Fw::Buffer& incoming_buffer);
 
  private:
    // ----------------------------------------------------------------------
    // Handler implementations for user-defined serial input ports
    // ----------------------------------------------------------------------
 
    void portIn_handler(NATIVE_INT_TYPE portNum, 
                        Fw::Buffer& Buffer       
    );
 
    BufferRepeaterFailureOption m_allocation_failure_response;  
};
 
}  // end namespace Svc
 
#endif