vapi_internal.h File Reference

internal vpp api C declarations More...

Include dependency graph for vapi_internal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	vapi_type_msg_header1_t
struct	vapi_type_msg_header2_t
struct	vapi_message_desc_t
struct	vapi_event_desc_t

Typedefs
typedef vapi_error_e(*	vapi_cb_t) (struct vapi_ctx_s *, void *, vapi_error_e, bool, void *)
typedef void(*	generic_swap_fn_t) (void *payload)

Functions
static void	vapi_type_msg_header1_t_hton (vapi_type_msg_header1_t *h)
static void	vapi_type_msg_header1_t_ntoh (vapi_type_msg_header1_t *h)
static void	vapi_type_msg_header2_t_hton (vapi_type_msg_header2_t *h)
static void	vapi_type_msg_header2_t_ntoh (vapi_type_msg_header2_t *h)
vapi_msg_id_t	vapi_register_msg (vapi_message_desc_t *msg)
u16	vapi_lookup_vl_msg_id (vapi_ctx_t ctx, vapi_msg_id_t id)
vapi_msg_id_t	vapi_lookup_vapi_msg_id_t (vapi_ctx_t ctx, u16 vl_msg_id)
int	vapi_get_client_index (vapi_ctx_t ctx)
bool	vapi_is_nonblocking (vapi_ctx_t ctx)
bool	vapi_requests_empty (vapi_ctx_t ctx)
bool	vapi_requests_full (vapi_ctx_t ctx)
size_t	vapi_get_request_count (vapi_ctx_t ctx)
size_t	vapi_get_max_request_count (vapi_ctx_t ctx)
u32	vapi_gen_req_context (vapi_ctx_t ctx)
void	vapi_store_request (vapi_ctx_t ctx, u32 context, bool is_dump, vapi_cb_t callback, void *callback_ctx)
int	vapi_get_payload_offset (vapi_msg_id_t id)
size_t	vapi_get_message_size (vapi_msg_id_t id)
size_t	vapi_get_context_offset (vapi_msg_id_t id)
bool	vapi_msg_is_with_context (vapi_msg_id_t id)
size_t	vapi_get_message_count ()
const char *	vapi_get_msg_name (vapi_msg_id_t id)
vapi_error_e	vapi_producer_lock (vapi_ctx_t ctx)
vapi_error_e	vapi_producer_unlock (vapi_ctx_t ctx)

Variables
void(*)(void *payload)	vapi_get_swap_to_host_func (vapi_msg_id_t id)
void(*)(void *payload)	vapi_get_swap_to_be_func (vapi_msg_id_t id)

Detailed Description

internal vpp api C declarations

This file contains internal vpp api C declarations. It's not intended to be used by the client programmer and the API defined here might change at any time..

Definition in file vapi_internal.h.

Typedef Documentation

generic_swap_fn_t

typedef void(* generic_swap_fn_t) (void *payload)

Definition at line 84 of file vapi_internal.h.

vapi_cb_t

typedef vapi_error_e(* vapi_cb_t) (struct vapi_ctx_s *, void *, vapi_error_e, bool, void *)

Definition at line 81 of file vapi_internal.h.

Function Documentation

vapi_gen_req_context()

u32 vapi_gen_req_context

(

vapi_ctx_t

ctx

)

Definition at line 94 of file vapi.c.

vapi_get_client_index()

int vapi_get_client_index

(

vapi_ctx_t

ctx

)

Definition at line 856 of file vapi.c.

vapi_get_context_offset()

size_t vapi_get_context_offset

(

vapi_msg_id_t

id

)

Definition at line 900 of file vapi.c.

Here is the caller graph for this function:

vapi_get_max_request_count()

size_t vapi_get_max_request_count

(

vapi_ctx_t

ctx

)

Definition at line 868 of file vapi.c.

vapi_get_message_count()

size_t vapi_get_message_count

(

)

Definition at line 965 of file vapi.c.

Here is the caller graph for this function:

vapi_get_message_size()

size_t vapi_get_message_size

(

vapi_msg_id_t

id

)

Definition at line 893 of file vapi.c.

Here is the caller graph for this function:

vapi_get_msg_name()

const char* vapi_get_msg_name

(

vapi_msg_id_t

id

)

Definition at line 971 of file vapi.c.

Here is the caller graph for this function:

vapi_get_payload_offset()

int vapi_get_payload_offset

(

vapi_msg_id_t

id

)

Definition at line 874 of file vapi.c.

Here is the caller graph for this function:

vapi_get_request_count()

size_t vapi_get_request_count

(

vapi_ctx_t

ctx

)

Definition at line 102 of file vapi.c.

vapi_is_nonblocking()

bool vapi_is_nonblocking

(

vapi_ctx_t

ctx

)

Definition at line 862 of file vapi.c.

vapi_lookup_vapi_msg_id_t()

vapi_msg_id_t vapi_lookup_vapi_msg_id_t	(	vapi_ctx_t	ctx,
		u16	vl_msg_id
	)

Definition at line 241 of file vapi.c.

Here is the caller graph for this function:

vapi_lookup_vl_msg_id()

u16 vapi_lookup_vl_msg_id	(	vapi_ctx_t	ctx,
		vapi_msg_id_t	id
	)

Definition at line 849 of file vapi.c.

Here is the caller graph for this function:

vapi_msg_is_with_context()

bool vapi_msg_is_with_context

(

vapi_msg_id_t

id

)

Definition at line 740 of file vapi.c.

Here is the caller graph for this function:

vapi_producer_lock()

vapi_error_e vapi_producer_lock

(

vapi_ctx_t

ctx

)

Definition at line 938 of file vapi.c.

vapi_producer_unlock()

vapi_error_e vapi_producer_unlock

(

vapi_ctx_t

ctx

)

Definition at line 951 of file vapi.c.

vapi_register_msg()

vapi_msg_id_t vapi_register_msg

(

vapi_message_desc_t *

msg

)

Definition at line 907 of file vapi.c.

vapi_requests_empty()

bool vapi_requests_empty

(

vapi_ctx_t

ctx

)

Definition at line 114 of file vapi.c.

Here is the caller graph for this function:

vapi_requests_full()

bool vapi_requests_full

(

vapi_ctx_t

ctx

)

Definition at line 108 of file vapi.c.

Here is the caller graph for this function:

vapi_store_request()

void vapi_store_request	(	vapi_ctx_t	ctx,
		u32	context,
		bool	is_dump,
		vapi_cb_t	callback,
		void *	callback_ctx
	)

Definition at line 126 of file vapi.c.

Here is the call graph for this function:

vapi_type_msg_header1_t_hton()

static void vapi_type_msg_header1_t_hton ( vapi_type_msg_header1_t *  h )

inlinestatic

Definition at line 55 of file vapi_internal.h.

vapi_type_msg_header1_t_ntoh()

static void vapi_type_msg_header1_t_ntoh ( vapi_type_msg_header1_t *  h )

inlinestatic

Definition at line 61 of file vapi_internal.h.

vapi_type_msg_header2_t_hton()

static void vapi_type_msg_header2_t_hton ( vapi_type_msg_header2_t *  h )

inlinestatic

Definition at line 67 of file vapi_internal.h.

vapi_type_msg_header2_t_ntoh()

static void vapi_type_msg_header2_t_ntoh ( vapi_type_msg_header2_t *  h )

inlinestatic

Definition at line 73 of file vapi_internal.h.

Variable Documentation

vapi_get_swap_to_be_func

void(*)(void *payload) vapi_get_swap_to_be_func(vapi_msg_id_t id)

Definition at line 124 of file vapi_internal.h.

vapi_get_swap_to_host_func

void(*)(void *payload) vapi_get_swap_to_host_func(vapi_msg_id_t id)

Definition at line 123 of file vapi_internal.h.