FD.io VPP
v20.09-64-g4f7b92f0a
Vector Packet Processing
udp.api
Go to the documentation of this file.
1
/* Hey Emacs use -*- mode: C -*- */
2
/*
3
* Copyright (c) 2018-2019 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
/**
18
* @file
19
*
20
* This file defines vpp UDP control-plane API messages which are generally
21
* called through a shared memory interface.
22
*/
23
24
option
version
=
"1.1.0"
;
25
26
import
"vnet/ip/ip_types.api"
;
27
28
29
/**
30
* @brief UDP Encap object
31
* @param table_id - table ID associated with the encap destination
32
* @param dst_ip - Encap destination address
33
* @param src_ip - Encap source address
34
* @param dst_port - Encap destination port
35
* @param src_port - Encap source port
36
* @param id - VPP assigned id; ignored in add message, set in dump
37
*/
38
typedef
udp_encap
39
{
40
u32
table_id
;
41
u16
src_port
;
42
u16
dst_port
;
43
vl_api_address_t
src_ip
;
44
vl_api_address_t
dst_ip
;
45
u32
id
;
46
};
47
48
/**
49
* @brief Add UDP encap
50
* @param client_index - opaque cookie to identify the sender
51
* @param context - sender context, to match reply w/ request
52
* @param udp_encap - UDP encap description
53
*/
54
define udp_encap_add
55
{
56
u32
client_index
;
57
u32
context
;
58
vl_api_udp_encap_t
udp_encap
;
59
};
60
61
/**
62
* @brief Add UDP encap reply
63
* @param context - sender context, to match reply w/ request
64
* @param retval - success/failure return value
65
* @param id - The ID of the encap object that should be used on delete
66
* and when reading stats from the stats segment.
67
*/
68
define udp_encap_add_reply
69
{
70
u32
context
;
71
i32
retval
;
72
u32
id
;
73
};
74
75
/**
76
* @brief Del UDP encap
77
* @param client_index - opaque cookie to identify the sender
78
* @param context - sender context, to match reply w/ request
79
* @param id - ID of the encap object the client chose during the add
80
*/
81
autoreply define udp_encap_del
82
{
83
u32
client_index
;
84
u32
context
;
85
u32
id
;
86
};
87
88
/**
89
* @brief dump UDP encaps
90
*/
91
define udp_encap_dump
92
{
93
u32
client_index
;
94
u32
context
;
95
};
96
97
/**
98
* @brief UDP encap details during dump
99
*/
100
define udp_encap_details
101
{
102
u32
context
;
103
vl_api_udp_encap_t
udp_encap
;
104
};
105
106
/*
107
* Local Variables:
108
* eval: (c-set-style "gnu")
109
* End:
110
*/
vl_api_udp_encap_add_t::client_index
u32 client_index
Definition:
udp.api:56
vl_api_udp_encap_del_t::id
u32 id
Definition:
udp.api:85
vl_api_udp_encap_details_t::context
u32 context
Definition:
udp.api:102
src_port
u16 src_port
Definition:
udp.api:41
u32
unsigned int u32
Definition:
types.h:88
vl_api_udp_encap_add_t::udp_encap
vl_api_udp_encap_t udp_encap
Definition:
udp.api:58
u16
unsigned short u16
Definition:
types.h:57
vl_api_udp_encap_add_reply_t::context
u32 context
Definition:
udp.api:70
version
option version
Definition:
udp.api:24
vl_api_udp_encap_del_t::client_index
u32 client_index
Definition:
udp.api:83
vl_api_udp_encap_add_reply_t::retval
i32 retval
Definition:
udp.api:71
vl_api_udp_encap_dump_t::context
u32 context
Definition:
udp.api:94
i32
signed int i32
Definition:
types.h:77
src_ip
vl_api_address_t src_ip
Definition:
udp.api:43
udp_encap
typedef udp_encap
UDP Encap object.
Definition:
udp.api:39
vl_api_udp_encap_dump_t::client_index
u32 client_index
Definition:
udp.api:93
vl_api_udp_encap_add_reply_t::id
u32 id
Definition:
udp.api:72
vl_api_udp_encap_del_t::context
u32 context
Definition:
udp.api:84
table_id
u32 table_id
Definition:
wireguard.api:100
dst_ip
vl_api_address_t dst_ip
Definition:
udp.api:44
id
u32 id
Definition:
udp.api:45
dst_port
u16 dst_port
Definition:
udp.api:42
vl_api_udp_encap_add_t::context
u32 context
Definition:
udp.api:57
vl_api_udp_encap_details_t::udp_encap
vl_api_udp_encap_t udp_encap
Definition:
udp.api:103
src
vnet
udp
udp.api
Generated on Thu Jun 3 2021 16:06:42 for FD.io VPP by
1.8.13