093a5a89726e0bd79846147e88f58a4e332f5ec1
[vpp.git] / src / vnet / tcp / tcp.api
1 /*
2  * Copyright (c) 2015-2016 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 /** \brief Configure TCP source addresses, for active-open TCP sessions
17
18     TCP src/dst ports are 16 bits, with the low-order 1024 ports
19     reserved. So, it's necessary to provide a considerable number of
20     source IP addresses if one wishes to initiate a large number of
21     connections.
22
23     Each of those addresses needs to have a receive adjacency - 
24     either a /32 or a /128 - and vpp needs to answer (proxy) arps or
25     neighbor discovery requests for the addresses. 
26
27     @param client_index - opaque cookie to identify the sender
28     @param context - sender context, to match reply w/ request
29     @param is_ipv6 - 1 for ipv6, 0 for ipv4
30     @param vrf_id - fib table / vrf id for local adjacencies
31     @param first_address - first address that TCP will use
32     @param last_address - last address that TCP will use
33 */
34 autoreply define tcp_configure_src_addresses {
35     u32 client_index;
36     u32 context;
37     u8 is_ipv6;
38     u32 vrf_id;
39     u8 first_address[16];
40     u8 last_address[16];
41  };
42