src/vlibapi/api_types.h

   1 /*
   2  *------------------------------------------------------------------
   3  * api_types.h
   4  *
   5  * Copyright (c) 2018 Cisco and/or its affiliates.
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *------------------------------------------------------------------
  18  */
  19
  20 #ifndef included_api_types_h
  21 #define included_api_types_h
  22
  23 #include <stdbool.h>
  24 #include <stdarg.h>
  25 #include <vppinfra/types.h>
  26 #include <arpa/inet.h>
  27 #include <string.h>
  28
  29 #ifdef __cplusplus
  30 extern "C"
  31 {
  32 #endif
  33
  34 /* VPP API string type */
  35 typedef struct
  36 {
  37   u32 length;
  38   u8 buf[0];
  39 } __attribute__ ((packed)) vl_api_string_t;
  40
  41 extern int vl_api_to_api_string (u32 len, const char *buf, vl_api_string_t * str);
  42 extern int vl_api_vec_to_api_string (const u8 *vec, vl_api_string_t * str);
  43 extern u8 * vl_api_from_api_string (vl_api_string_t * astr);
  44 extern u32 vl_api_string_len (vl_api_string_t * astr);
  45 extern u8 * vl_api_from_api_to_vec (vl_api_string_t *astr);
  46 extern u8 *vl_api_format_string (u8 *s, va_list *args);
  47
  48 #ifdef __cplusplus
  49 }
  50 #endif
  51
  52 #endif