extras/vom/vom/ip_unnumbered_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_IP_UNNUMBERED_CMDS_H__
  17 #define __VOM_IP_UNNUMBERED_CMDS_H__
  18
  19 #include "vom/ip_unnumbered.hpp"
  20 #include "vom/rpc_cmd.hpp"
  21
  22 #include <vapi/interface.api.vapi.hpp>
  23
  24 namespace VOM {
  25 namespace ip_unnumbered_cmds {
  26
  27 /**
  28 *A command class that configures the IP unnumbered
  29 */
  30 class config_cmd
  31   : public rpc_cmd<HW::item<bool>, rc_t, vapi::Sw_interface_set_unnumbered>
  32 {
  33 public:
  34   /**
  35    * Constructor
  36    */
  37   config_cmd(HW::item<bool>& item, const handle_t& itf, const handle_t& l3_itf);
  38
  39   /**
  40    * Issue the command to VPP/HW
  41    */
  42   rc_t issue(connection& con);
  43   /**
  44    * convert to string format for debug purposes
  45    */
  46   std::string to_string() const;
  47
  48   /**
  49    * Comparison operator - only used for UT
  50    */
  51   bool operator==(const config_cmd& i) const;
  52
  53 private:
  54   /**
  55    * Reference to the interface for which the address is required
  56    */
  57   const handle_t& m_itf;
  58   /**
  59    * Reference to the interface which has an address
  60    */
  61   const handle_t& m_l3_itf;
  62 };
  63
  64 /**
  65  * A cmd class that Unconfigs L3 Config from an interface
  66  */
  67 class unconfig_cmd
  68   : public rpc_cmd<HW::item<bool>, rc_t, vapi::Sw_interface_set_unnumbered>
  69 {
  70 public:
  71   /**
  72    * Constructor
  73    */
  74   unconfig_cmd(HW::item<bool>& item,
  75                const handle_t& itf,
  76                const handle_t& l3_itf);
  77
  78   /**
  79    * Issue the command to VPP/HW
  80    */
  81   rc_t issue(connection& con);
  82   /**
  83    * convert to string format for debug purposes
  84    */
  85   std::string to_string() const;
  86
  87   /**
  88    * Comparison operator - only used for UT
  89    */
  90   bool operator==(const unconfig_cmd& i) const;
  91
  92 private:
  93   /**
  94    * Reference to the interface for which the address is required
  95    */
  96   const handle_t& m_itf;
  97   /**
  98    * Reference to the interface which has an address
  99    */
 100   const handle_t& m_l3_itf;
 101 };
 102
 103 }; // namespace ip_unnumbered_cmds
 104 }; // namespace VOM
 105
 106 /*
 107  * fd.io coding-style-patch-verification: ON
 108  *
 109  * Local Variables:
 110  * eval: (c-set-style "mozilla")
 111  * End:
 112  */
 113
 114 #endif