MAP: Use explicit address/prefix types in API
[vpp.git] / src / vnet / ip / ip_types.api
1 /* Hey Emacs use -*- mode: C -*- */
2 /*
3  * Copyright (c) 2018 Cisco and/or its affiliates.
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 typedef ip4_address {
18   u8 address[4];
19 };
20
21 typedef ip6_address {
22   u8 address[16];
23 };
24
25 enum address_family {
26   ADDRESS_IP4 = 0,
27   ADDRESS_IP6,
28 };
29
30 union address_union {
31   vl_api_ip4_address_t ip4;
32   vl_api_ip6_address_t ip6;
33 };
34
35 typedef address {
36   vl_api_address_family_t af;
37   vl_api_address_union_t un;
38 };
39
40 typedef prefix {
41   vl_api_address_t address;
42   u8 address_length;
43 };
44
45 typedef mprefix {
46   vl_api_address_family_t af;
47   u16 grp_address_length;
48   vl_api_address_union_t grp_address;
49   vl_api_address_union_t src_address;
50 };
51
52 typedef ip6_prefix {
53   vl_api_ip6_address_t prefix;
54   u8 len;
55 };
56
57 typedef ip4_prefix {
58   vl_api_ip4_address_t prefix;
59   u8 len;
60 };