ping: Simple binary API for running ping based on events
[vpp.git] / src / plugins / ping / ping.api
1 /* Hey Emacs use -*- mode: C -*- */
2 /*
3  * Copyright (c) 2023 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 option version = "0.1.0";
18 import "vnet/interface_types.api";
19 import "vnet/ip/ip_types.api";
20
21 autoreply define want_ping_finished_events
22 {
23   u32 client_index;
24   u32 context;
25   vl_api_address_t address;
26   u32 repeat [default=1];
27   f64 interval [default=1.0];
28 };
29
30 define ping_finished_event
31 {
32   u32 client_index;
33   u32 request_count;
34   u32 reply_count;
35 };
36
37 service {
38   rpc want_ping_finished_events returns want_ping_finished_events_reply
39     events ping_finished_event;
40 };
41
42 /*
43  * Local Variables:
44  * eval: (c-set-style "gnu")
45  * End:
46  */