FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
api_types.h
Go to the documentation of this file.
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 {
38  u8 buf[0];
39 } __attribute__ ((packed)) vl_api_string_t;
40 
41 /* Nul terminated string to vl_api_string_t */
42 extern int vl_api_c_string_to_api_string (const char *buf, vl_api_string_t * str);
43 /* NON nul terminated vector to vl_api_string_t */
44 extern int vl_api_vec_to_api_string (const u8 *vec, vl_api_string_t * str);
45 
46 extern u32 vl_api_string_len (vl_api_string_t * astr);
47 
48 /* Returns new vector. NON nul terminated */
49 extern u8 * vl_api_from_api_to_new_vec (void *mp, vl_api_string_t *astr);
50 /* Returns new vector. Nul terminated */
52 
53 extern u8 *vl_api_format_string (u8 *s, va_list *args);
54 
55 #ifdef __cplusplus
56 }
57 #endif
58 
59 #endif
int vl_api_vec_to_api_string(const u8 *vec, vl_api_string_t *str)
Definition: api_shared.c:1161
Optimized string handling code, including c11-compliant "safe C library" variants.
unsigned char u8
Definition: types.h:56
unsigned int u32
Definition: types.h:88
u8 * vl_api_format_string(u8 *s, va_list *args)
Definition: api_shared.c:1176
u32 vl_api_string_len(vl_api_string_t *astr)
Definition: api_shared.c:1170
u8 * vl_api_from_api_to_new_vec(void *mp, vl_api_string_t *astr)
Definition: api_shared.c:1188
char * vl_api_from_api_to_new_c_string(vl_api_string_t *astr)
Definition: api_shared.c:1204
int vl_api_c_string_to_api_string(const char *buf, vl_api_string_t *str)
Definition: api_shared.c:1149