extras/vom/vom/qos_store_cmds.hpp

   1 /*
   2  * Copyright (c) 2019 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef __VOM_QOS_STORE_CMDS_H__
  17 #define __VOM_QOS_STORE_CMDS_H__
  18
  19 #include "vom/dump_cmd.hpp"
  20 #include "vom/qos_store.hpp"
  21
  22 #include <vapi/qos.api.vapi.hpp>
  23
  24 namespace VOM {
  25 namespace QoS {
  26 namespace store_cmds {
  27
  28 /**
  29  * A command class that creates or updates the GBP endpoint
  30  */
  31 class create_cmd
  32   : public rpc_cmd<HW::item<bool>, vapi::Qos_store_enable_disable>
  33 {
  34 public:
  35   /**
  36    * Constructor
  37    */
  38   create_cmd(HW::item<bool>& item,
  39              const handle_t& itf,
  40              const source_t& src,
  41              bits_t value);
  42
  43   /**
  44    * Issue the command to VPP/HW
  45    */
  46   rc_t issue(connection& con);
  47
  48   /**
  49    * convert to string format for debug purposes
  50    */
  51   std::string to_string() const;
  52
  53   /**
  54    * Comparison operator - only used for UT
  55    */
  56   bool operator==(const create_cmd& i) const;
  57
  58 private:
  59   handle_t m_itf;
  60   const source_t& m_src;
  61   bits_t m_value;
  62 };
  63
  64 /**
  65  * A cmd class that deletes a GBP endpoint
  66  */
  67 class delete_cmd
  68   : public rpc_cmd<HW::item<bool>, vapi::Qos_store_enable_disable>
  69 {
  70 public:
  71   /**
  72    * Constructor
  73    */
  74   delete_cmd(HW::item<bool>& item, const handle_t& itf, const source_t& src);
  75
  76   /**
  77    * Issue the command to VPP/HW
  78    */
  79   rc_t issue(connection& con);
  80
  81   /**
  82    * convert to string format for debug purposes
  83    */
  84   std::string to_string() const;
  85
  86   /**
  87    * Comparison operator - only used for UT
  88    */
  89   bool operator==(const delete_cmd& i) const;
  90
  91 private:
  92   const handle_t m_itf;
  93   const source_t& m_src;
  94 };
  95
  96 /**
  97  * A cmd class that Dumps all the GBP endpoints
  98  */
  99 class dump_cmd : public VOM::dump_cmd<vapi::Qos_store_dump>
 100 {
 101 public:
 102   /**
 103    * Constructor
 104    */
 105   dump_cmd();
 106   dump_cmd(const dump_cmd& d);
 107
 108   /**
 109    * Issue the command to VPP/HW
 110    */
 111   rc_t issue(connection& con);
 112   /**
 113    * convert to string format for debug purposes
 114    */
 115   std::string to_string() const;
 116
 117   /**
 118    * Comparison operator - only used for UT
 119    */
 120   bool operator==(const dump_cmd& i) const;
 121
 122 private:
 123   /**
 124    * HW reutrn code
 125    */
 126   HW::item<bool> item;
 127 };
 128 }; // namespace store_cmds
 129 }; // namespace Qos
 130 }; // namespace VOM
 131
 132 /*
 133  * fd.io coding-style-patch-verification: ON
 134  *
 135  * Local Variables:
 136  * eval: (c-set-style "mozilla")
 137  * End:
 138  */
 139
 140 #endif