fsfw/src/fsfw/cfdp/handler/FaultHandlerBase.h

#ifndef FSFW_CFDP_FAULTHANDLERBASE_H
#define FSFW_CFDP_FAULTHANDLERBASE_H

#include <etl/flat_map.h>

#include "fsfw/cfdp/VarLenFields.h"
#include "fsfw/cfdp/definitions.h"

namespace cfdp {

/**
 * @brief Provides a way to implement the fault handling procedures as specified
 * in chapter 4.8 of the CFDP standard.
 *
 * @details
 * It is passed into the CFDP handlers as part of the local entity configuration and provides
 * a way to specify custom user error handlers.
 *
 * It does so by mapping each applicable CFDP condition code to a fault handler which
 * is denoted by the four @cfdp::FaultHandlerCodes. This code is used to dispatch
 * to a user-provided callback function:
 *
 * 1. @FaultHandlerCodes::IGNORE_ERROR -> @ignore_cb
 * 2. @FaultHandlerCodes::NOTICE_OF_CANCELLATION` -> @notice_of_cancellation_cb
 * 3. @FaultHandlerCodes::NOTICE_OF_SUSPENSION` -> @notice_of_suspension_cb
 * 4. @FaultHandlerCodes::ABANDON_TRANSACTION` -> @abandon_transaction_cb
 *
 * For each error reported by @reportError, the appropriate fault handler callback
 * will be called. The user provides the callbacks by providing a custom class which implements
 * these base class and all abstract fault handler callbacks.
 */
class FaultHandlerBase {
 public:
  virtual ~FaultHandlerBase();
  FaultHandlerBase();

  /**
   * Get the fault handler code for the given condition code
   * @param code
   * @param handler [out] Will be set to the approrpiate handler for the condition code if
   *    it is valid
   * @return
   *  - true if the condition code is valid
   *  - false otherwise
   */
  bool getFaultHandler(cfdp::ConditionCode code, cfdp::FaultHandlerCode& handler) const;

  bool setFaultHandler(cfdp::ConditionCode code, cfdp::FaultHandlerCode handler);

  bool reportFault(cfdp::TransactionId& id, cfdp::ConditionCode code);

  virtual void noticeOfSuspensionCb(cfdp::TransactionId& id, cfdp::ConditionCode code) = 0;
  virtual void noticeOfCancellationCb(cfdp::TransactionId& id, cfdp::ConditionCode code) = 0;
  virtual void abandonCb(cfdp::TransactionId& id, cfdp::ConditionCode code) = 0;
  virtual void ignoreCb(cfdp::TransactionId& id, cfdp::ConditionCode code) = 0;

 private:
  etl::flat_map<cfdp::ConditionCode, cfdp::FaultHandlerCode, 10> faultHandlerMap = {
      etl::pair{cfdp::ConditionCode::POSITIVE_ACK_LIMIT_REACHED,
                cfdp::FaultHandlerCode::IGNORE_ERROR},
      etl::pair{cfdp::ConditionCode::KEEP_ALIVE_LIMIT_REACHED,
                cfdp::FaultHandlerCode::IGNORE_ERROR},
      etl::pair{cfdp::ConditionCode::INVALID_TRANSMISSION_MODE,
                cfdp::FaultHandlerCode::IGNORE_ERROR},
      etl::pair{cfdp::ConditionCode::FILE_CHECKSUM_FAILURE, cfdp::FaultHandlerCode::IGNORE_ERROR},
      etl::pair{cfdp::ConditionCode::FILE_SIZE_ERROR, cfdp::FaultHandlerCode::IGNORE_ERROR},
      etl::pair{cfdp::ConditionCode::NAK_LIMIT_REACHED, cfdp::FaultHandlerCode::IGNORE_ERROR},
      etl::pair{cfdp::ConditionCode::INACTIVITY_DETECTED, cfdp::FaultHandlerCode::IGNORE_ERROR},
      etl::pair{cfdp::ConditionCode::UNSUPPORTED_CHECKSUM_TYPE,
                cfdp::FaultHandlerCode::IGNORE_ERROR},
      etl::pair{cfdp::ConditionCode::FILESTORE_REJECTION, cfdp::FaultHandlerCode::IGNORE_ERROR},
      etl::pair{cfdp::ConditionCode::CHECK_LIMIT_REACHED, cfdp::FaultHandlerCode::IGNORE_ERROR}};
};

}  // namespace cfdp

#endif  // FSFW_CFDP_FAULTHANDLERBASE_H