summaryrefslogtreecommitdiffstats
path: root/src/vpp-api/vom/bond_member.hpp
blob: 066933b74d75ddf9be0c9c233a1f41716df08919 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/*
 * Copyright (c) 2018 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __VOM_BOND_MEMBER_H__
#define __VOM_BOND_MEMBER_H__

#include "vom/interface.hpp"
#include <vapi/bond.api.vapi.hpp>

namespace VOM {
/**
 * A bond-member. e.g. a bond_member interface
 */
class bond_member
{
public:
  /**
   * A member interface mode
   */
  struct mode_t : enum_base<mode_t>
  {
    /**
     * Active member interface mode
     */
    const static mode_t ACTIVE;
    /**
     * Passive member interface mode
     */
    const static mode_t PASSIVE;

    /**
     * Convert VPP's value of the bond to a mode
     */
    static const mode_t from_numeric_val(uint8_t v);

  private:
    /**
     * Private constructor taking the value and the string name
     */
    mode_t(int v, const std::string& s);
  };

  /**
   * A member interface rate
   */
  struct rate_t : enum_base<rate_t>
  {
    /**
     * Fast member interface rate
     */
    const static rate_t FAST;
    /**
     * SLOW member interface rate
     */
    const static rate_t SLOW;

    /**
     * Convert VPP's value of the bond to a mode
     */
    static const rate_t from_numeric_val(uint8_t v);

  private:
    /**
     * Private constructor taking the value and the string name
     */
    rate_t(int v, const std::string& s);
  };

  bond_member(const interface& itf, mode_t mode, rate_t rate);

  ~bond_member();
  bond_member(const bond_member& o);

  /**
   * convert to VPP
   */
  void to_vpp(vapi_payload_bond_enslave& bond_enslave) const;

  /**
   * set the mode
   */
  void set(mode_t mode);

  /**
   * set the rate
   */
  void set(rate_t rate);

  /**
   * convert to string
   */
  std::string to_string(void) const;

  /**
   * less-than operator
   */
  bool operator<(const bond_member& mem_itf) const;

  /**
   * Get the interface handle
   */
  const handle_t hdl(void) const;

  /**
   * equality operator
   */
  bool operator==(const bond_member& i) const;

private:
  /**
   * Refernece conter lock on the parent
   */
  const std::shared_ptr<interface> m_itf;

  /**
   * passive vs active member
   */
  mode_t m_mode;

  /**
   * slow 90sec. vs. fast 3sec timeout
   */
  rate_t m_rate;
};
}

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "mozilla")
 * End:
 */

#endif