FD.io VPP  v19.08-27-gf4dcae4
Vector Packet Processing
nsim.api
Go to the documentation of this file.
1 /**
2  * @file nsim.api
3  * @brief VPP control-plane API messages for the network delay simulator
4  */
5 
6 option version = "2.1.0";
7 
8 /** \brief enable / disable the network delay simulation cross-connect
9  @param client_index - opaque cookie to identify the sender
10  @param context - sender context, to match reply w/ request
11  @param enable_disable - enable or disable the feature
12  @param sw_if_index0 - one interface to cross-connect
13  @param sw_if_index1 - the other interface to cross-connect
14 */
16 {
17  /* Client identifier, set from api_main.my_client_index */
19 
20  /* Arbitrary context, so client can match reply to request */
22 
23  /* Enable / disable the feature on the interfaces */
25 
26  /* Interface handles */
29 };
30 
31 /** \brief enable / disable the network delay simulation output feature
32  @param client_index - opaque cookie to identify the sender
33  @param context - sender context, to match reply w/ request
34  @param enable_disable - enable or disable the feature
35  @param sw_if_index0 - interface
36 */
38 {
39  /* Client identifier, set from api_main.my_client_index */
41 
42  /* Arbitrary context, so client can match reply to request */
44 
45  /* Enable / disable the feature on the interfaces */
47 
48  /* Interface handles */
50 };
51 
52 /** \brief configure the network delay simulation cross-connect
53  @param client_index - opaque cookie to identify the sender
54  @param context - sender context, to match reply w/ request
55  @param delay_in_usec - microseconds of link delay to simulate
56  @param average_packet_size - average packet size for wheel sizing
57  @param bandwidth_in_bits_per_second - bps for wheel sizing
58 */
59 autoreply define nsim_configure
60 {
61  /* Client identifier, set from api_main.my_client_index */
63 
64  /* Arbitrary context, so client can match reply to request */
66 
67  /* Configuration parameters */
72 };
73 
74 
unsigned long u64
Definition: types.h:89
int nsim_cross_connect_enable_disable(nsim_main_t *nsm, u32 sw_if_index0, u32 sw_if_index1, int enable_disable)
Definition: nsim.c:71
unsigned char u8
Definition: types.h:56
unsigned int u32
Definition: types.h:88
static int nsim_configure(nsim_main_t *nsm, f64 bandwidth, f64 delay, f64 packet_size, f64 drop_fraction)
Definition: nsim.c:157
option version
Definition: nsim.api:6
int nsim_output_feature_enable_disable(nsim_main_t *nsm, u32 sw_if_index, int enable_disable)
Definition: nsim.c:122
u64 bandwidth_in_bits_per_second
Definition: nsim.api:70