src/vnet/udp/udp.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   3  * Copyright (c) 2018 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 - The ID assigned to this encap object by the caller
  37  */
  38 typedef udp_encap
  39 {
  40   u32 id;
  41   u32 table_id;
  42   u16 src_port;
  43   u16 dst_port;
  44   vl_api_address_t src_ip;
  45   vl_api_address_t dst_ip;
  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 autoreply 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 Del UDP encap
  63  * @param client_index - opaque cookie to identify the sender
  64  * @param context - sender context, to match reply w/ request
  65  * @param id - ID of the encap object the client chose during the add
  66 */
  67 autoreply define udp_encap_del
  68 {
  69   u32 client_index;
  70   u32 context;
  71   u32 id;
  72 };
  73
  74 /**
  75  * @brief dump UDP encaps
  76  */
  77 define udp_encap_dump
  78 {
  79   u32 client_index;
  80   u32 context;
  81 };
  82
  83 /**
  84  * @brief UDP encap details during dump
  85  */
  86 define udp_encap_details
  87 {
  88   u32 context;
  89   vl_api_udp_encap_t udp_encap;
  90 };
  91
  92 /*
  93  * Local Variables:
  94  * eval: (c-set-style "gnu")
  95  * End:
  96  */