extras/vom/vom/hw_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_HW_CMDS_H__
  17 #define __VOM_HW_CMDS_H__
  18
  19 #include <vapi/vapi.hpp>
  20 #include <vapi/vpe.api.vapi.hpp>
  21
  22 #include "vom/hw.hpp"
  23 #include "vom/rpc_cmd.hpp"
  24
  25 namespace VOM {
  26 namespace hw_cmds {
  27 /**
  28 *A command poll the HW for liveness
  29 */
  30 class poll : public rpc_cmd<HW::item<bool>, vapi::Control_ping>
  31 {
  32 public:
  33   /**
  34    * Constructor taking the HW::item to update
  35    */
  36   poll(HW::item<bool>& item);
  37
  38   /**
  39    * Issue the command to VPP/HW
  40    */
  41   rc_t issue(connection& con);
  42
  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 poll& i) const;
  52 };
  53 };
  54 };
  55
  56 /*
  57  * fd.io coding-style-patch-verification: ON
  58  *
  59  * Local Variables:
  60  * eval: (c-set-style "mozilla")
  61  * End:
  62  */
  63
  64 #endif