PFPObserver.h

Go to the documentation of this file.

/*
 * PFPSim: Library for the Programmable Forwarding Plane Simulation Framework
 *
 * Copyright (C) 2016 Concordia Univ., Montreal
 *     Samar Abdi
 *     Umair Aftab
 *     Gordon Bailey
 *     Faras Dewal
 *     Shafigh Parsazad
 *     Eric Tremblay
 *
 * Copyright (C) 2016 Ericsson
 *     Bochra Boughzala
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

#ifndef CORE_PFPOBSERVER_H_
#define CORE_PFPOBSERVER_H_

#include <string>
#include <memory>

namespace pfp {
namespace core {

class PFPObserver {
 public:
  virtual void counter_added(const std::string& module_name,
          const std::string& counter_name,
          double simulation_time = 0) = 0;

  virtual void counter_removed(const std::string& module_name,
          const std::string& counter_name,
          double simulation_time = 0) = 0;

  virtual void counter_updated(const std::string& module_name,
          const std::string& counter_name,
          std::size_t new_value,
          double simulation_time) = 0;

  virtual void data_written(const std::string& from_module,
          const std::shared_ptr<pfp::core::TrType> data,
          double simulation_time) = 0;

  virtual void data_read(const std::string& to_module,
           const std::shared_ptr<pfp::core::TrType> data,
           double simulation_time) = 0;

  virtual void data_dropped(const std::string& in_module,
            const std::shared_ptr<pfp::core::TrType> data,
            const std::string& drop_reason,
            double simulation_time) = 0;

  virtual void thread_begin(const std::string& teu_mod,
            const std::string& tec_mod,
            std::size_t thread_id,
            std::size_t packet_id,
            double simulation_time) = 0;

  virtual void thread_end(const std::string& teu_mod,
            const std::string& tec_mod,
            std::size_t thread_id,
            std::size_t packet_id,
            double simulation_time) = 0;

  virtual void thread_idle(const std::string& teu_mod,
            const std::string& tec_mod,
            std::size_t thread_id,
            std::size_t packet_id,
            double simulation_time) = 0;

  virtual void core_busy(const std::string& teu_mod,
            const std::string& tec_mod,
            double simulation_time) = 0;

  virtual void core_idle(const std::string& teu_mod,
            const std::string& tec_mod,
            double simulation_time) = 0;

 protected:
  virtual ~PFPObserver() = default;
};
};  // namespace core
};  // namespace pfp
#endif  // CORE_PFPOBSERVER_H_