extras/vom/vom/gbp_route_domain_cmds.hpp

   1 /*
   2  * Copyright (c) 2017 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_GBP_ROUTE_DOMAIN_CMDS_H__
  17 #define __VOM_GBP_ROUTE_DOMAIN_CMDS_H__
  18
  19 #include "vom/dump_cmd.hpp"
  20 #include "vom/gbp_route_domain.hpp"
  21 #include "vom/rpc_cmd.hpp"
  22
  23 #include <vapi/gbp.api.vapi.hpp>
  24
  25 namespace VOM {
  26 namespace gbp_route_domain_cmds {
  27 /**
  28  * A command class that creates an Route-Domain
  29  */
  30 class create_cmd
  31   : public rpc_cmd<HW::item<uint32_t>, vapi::Gbp_route_domain_add>
  32 {
  33 public:
  34   /**
  35    * Constructor
  36    */
  37   create_cmd(HW::item<uint32_t>& item,
  38              const handle_t ip4_uu_fwd,
  39              const handle_t ip6_uu_fwd);
  40
  41   /**
  42    * Issue the command to VPP/HW
  43    */
  44   rc_t issue(connection& con);
  45   /**
  46    * convert to string format for debug purposes
  47    */
  48   std::string to_string() const;
  49
  50   /**
  51    * Comparison operator - only used for UT
  52    */
  53   bool operator==(const create_cmd& i) const;
  54
  55 private:
  56   const handle_t m_ip4_uu_fwd;
  57   const handle_t m_ip6_uu_fwd;
  58 };
  59
  60 /**
  61  * A cmd class that Delete an Route-Domain
  62  */
  63 class delete_cmd
  64   : public rpc_cmd<HW::item<uint32_t>, vapi::Gbp_route_domain_del>
  65 {
  66 public:
  67   /**
  68    * Constructor
  69    */
  70   delete_cmd(HW::item<uint32_t>& item);
  71
  72   /**
  73    * Issue the command to VPP/HW
  74    */
  75   rc_t issue(connection& con);
  76   /**
  77    * convert to string format for debug purposes
  78    */
  79   std::string to_string() const;
  80
  81   /**
  82    * Comparison operator - only used for UT
  83    */
  84   bool operator==(const delete_cmd& i) const;
  85 };
  86
  87 /**
  88  * A cmd class that Dumps all the route domains
  89  */
  90 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_route_domain_dump>
  91 {
  92 public:
  93   /**
  94    * Constructor
  95    */
  96   dump_cmd() = default;
  97   dump_cmd(const dump_cmd& d) = default;
  98
  99   /**
 100    * Issue the command to VPP/HW
 101    */
 102   rc_t issue(connection& con);
 103   /**
 104    * convert to string format for debug purposes
 105    */
 106   std::string to_string() const;
 107
 108   /**
 109    * Comparison operator - only used for UT
 110    */
 111   bool operator==(const dump_cmd& i) const;
 112
 113 private:
 114   /**
 115    * HW reutrn code
 116    */
 117   HW::item<bool> item;
 118 };
 119
 120 }; // gbp_route_domain_cmds
 121 }; // VOM
 122
 123 /*
 124  * fd.io coding-style-patch-verification: ON
 125  *
 126  * Local Variables:
 127  * eval: (c-set-style "mozilla")
 128  * End:
 129  */
 130
 131 #endif