FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
builtinurl.api
Go to the documentation of this file.
1 /*
2  * builtinurl.api - binary API skeleton
3  *
4  * Copyright (c) <current-year> <your-organization>
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 /**
19  * @file builtinurl.api
20  * @brief VPP control-plane API messages.
21  *
22  * This file defines VPP control-plane binary API messages which are generally
23  * called through a shared memory interface.
24  */
25 
26 /* Version and type recitations */
27 
28 option version = "1.0.0";
29 
30 /** @brief API to enable / disable builtinurl on an interface
31  @param client_index - opaque cookie to identify the sender
32  @param context - sender context, to match reply w/ request
33  @param enable_disable - 1 to enable, 0 to disable the feature
34  @param sw_if_index - interface handle
35 */
36 
37 autoreply define builtinurl_enable {
38  /* Client identifier, set from api_main.my_client_index */
40 
41  /* Arbitrary context, so client can match reply to request */
43 };
unsigned int u32
Definition: types.h:88
option version
Definition: builtinurl.api:28
int builtinurl_enable(builtinurl_main_t *bmp)
Definition: builtinurl.c:39