src/vnet/udp/udp.api

   1 /*
   2  * Copyright (c) 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 /** \file
  17
  18     This file defines vpp UDP control-plane API messages which are generally
  19     called through a shared memory interface.
  20 */
  21
  22 option version = "1.0.0";
  23
  24 /** \brief Add / del table request
  25            A table can be added multiple times, but need be deleted only once.
  26     @param client_index - opaque cookie to identify the sender
  27     @param context - sender context, to match reply w/ request
  28     @param is_ipv6 - V4 or V6 table
  29     @param table_id - table ID associated with the encap destination
  30 */
  31 autoreply define udp_encap_add_del
  32 {
  33   u32 client_index;
  34   u32 context;
  35   u32 id;
  36   u32 table_id;
  37   u8 is_ip6;
  38   u8 is_add;
  39   u16 src_port;
  40   u16 dst_port;
  41   u8 src_ip[16];
  42   u8 dst_ip[16];
  43 };
  44
  45 define udp_encap_dump
  46 {
  47   u32 client_index;
  48   u32 context;
  49 };
  50
  51 define udp_encap_details
  52 {
  53   u32 context;
  54   u32 id;
  55   u32 table_id;
  56   u8 is_ip6;
  57   u16 src_port;
  58   u16 dst_port;
  59   u8 src_ip[16];
  60   u8 dst_ip[16];
  61 };
  62
  63 /*
  64  * Local Variables:
  65  * eval: (c-set-style "gnu")
  66  * End:
  67  */