FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
vapi_common.h File Reference
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define VAPI_INVALID_MSG_ID   ((vapi_msg_id_t)(~0))
 

Typedefs

typedef unsigned int vapi_msg_id_t
 

Enumerations

enum  vapi_error_e {
  VAPI_OK = 0, VAPI_EINVAL, VAPI_EAGAIN, VAPI_ENOTSUP,
  VAPI_ENOMEM, VAPI_ENORESP, VAPI_EMAP_FAIL, VAPI_ECON_FAIL,
  VAPI_EINCOMPATIBLE, VAPI_MUTEX_FAILURE, VAPI_EUSER
}
 
enum  vapi_mode_e { VAPI_MODE_BLOCKING = 1, VAPI_MODE_NONBLOCKING = 2 }
 
enum  vapi_wait_mode_e { VAPI_WAIT_FOR_READ, VAPI_WAIT_FOR_WRITE, VAPI_WAIT_FOR_READ_WRITE }
 

Macro Definition Documentation

◆ VAPI_INVALID_MSG_ID

#define VAPI_INVALID_MSG_ID   ((vapi_msg_id_t)(~0))

Definition at line 57 of file vapi_common.h.

Typedef Documentation

◆ vapi_msg_id_t

typedef unsigned int vapi_msg_id_t

Definition at line 55 of file vapi_common.h.

Enumeration Type Documentation

◆ vapi_error_e

Enumerator
VAPI_OK 

success

VAPI_EINVAL 

invalid value encountered

VAPI_EAGAIN 

operation would block

VAPI_ENOTSUP 

operation not supported

VAPI_ENOMEM 

out of memory

VAPI_ENORESP 

no response to request

VAPI_EMAP_FAIL 

failure while mapping api

VAPI_ECON_FAIL 

failure while connecting to vpp

VAPI_EINCOMPATIBLE 

fundamental incompatibility while connecting to vpp (control ping/control ping reply mismatch)

VAPI_MUTEX_FAILURE 

failure manipulating internal mutex(es)

VAPI_EUSER 

user error used for breaking dispatch, never used by VAPI

Definition at line 25 of file vapi_common.h.

◆ vapi_mode_e

Enumerator
VAPI_MODE_BLOCKING 

operations block until response received

VAPI_MODE_NONBLOCKING 

operations never block

Definition at line 42 of file vapi_common.h.

◆ vapi_wait_mode_e

Enumerator
VAPI_WAIT_FOR_READ 

wait until some message is readable

VAPI_WAIT_FOR_WRITE 

wait until a message can be written

VAPI_WAIT_FOR_READ_WRITE 

wait until a read or write can be done

Definition at line 48 of file vapi_common.h.