X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvcl%2Fvppcom.h;h=c752e50413b24f80be4934764a05378f990dac12;hb=410bcca41c1a3e7c3d4b4c2940120f9b21732d49;hp=208b3717d03a2c2b351ea26e7d584335b92f1e6c;hpb=048b1d6ab787e46ad91574ac950329bccc7fe809;p=vpp.git diff --git a/src/vcl/vppcom.h b/src/vcl/vppcom.h index 208b3717d03..c752e50413b 100644 --- a/src/vcl/vppcom.h +++ b/src/vcl/vppcom.h @@ -21,14 +21,21 @@ #include #include +/* *INDENT-OFF* */ +#ifdef __cplusplus +extern "C" +{ +#endif +/* *INDENT-ON* */ + /* * VPPCOM Public API Definitions, Enums, and Data Structures */ #define INVALID_SESSION_ID (~0) -#define VPPCOM_VRF_DEFAULT 0 #define VPPCOM_CONF_DEFAULT "/etc/vpp/vcl.conf" #define VPPCOM_ENV_CONF "VCL_CONFIG" #define VPPCOM_ENV_DEBUG "VCL_DEBUG" +#define VPPCOM_ENV_API_PREFIX "VCL_API_PREFIX" #define VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP "VCL_APP_PROXY_TRANSPORT_TCP" #define VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP "VCL_APP_PROXY_TRANSPORT_UDP" #define VPPCOM_ENV_APP_NAMESPACE_ID "VCL_APP_NAMESPACE_ID" @@ -70,7 +77,6 @@ typedef enum typedef struct vppcom_endpt_t_ { - uint32_t vrf; uint8_t is_cut_thru; uint8_t is_ip4; uint8_t *ip; @@ -138,6 +144,13 @@ typedef struct _vcl_poll short *revents; } vcl_poll_t; +typedef struct vppcom_ioevent_ +{ + uint32_t session_index; + size_t bytes; +} vppcom_ioevent_t; + + /* * VPPCOM Public API Functions */ @@ -204,16 +217,84 @@ vppcom_retval_str (int retval) return st; } +/** + * User registered callback for when connection arrives on listener created + * with vppcom_session_register_listener() + * @param uint32_t - newly accepted session_index + * @param vppcom_endpt_t* - ip/port information of remote + * @param void* - user passed arg to pass back + */ +typedef void (*vppcom_session_listener_cb) (uint32_t, vppcom_endpt_t *, + void *); + +/** + * User registered callback for IO events (rx/tx) + * @param vppcom_ioevent_t* - + * @param void* - user passed arg to pass back + */ +typedef void (*vppcom_session_ioevent_cb) (vppcom_ioevent_t *, void *); + +/** + * @brief vppcom_session_register_listener accepts a bound session_index, and + * listens for connections. + * + * On successful connection, calls registered callback (cb) with new + * session_index. + * + * On error, calls registered error callback (errcb). + * + * @param session_index - bound session_index to create listener on + * @param cb - on new accepted session callback + * @param errcb - on failure callback + * @param flags - placeholder for future use. Must be ZERO + * @param q_len - max listener connection backlog + * @param ptr - user data + * @return + */ +extern int vppcom_session_register_ioevent_cb (uint32_t session_index, + vppcom_session_ioevent_cb cb, + uint8_t rx, void *ptr); + +/** + * User registered ERROR callback for any errors associated with + * handling vppcom_session_register_listener() and connections + * @param void* - user passed arg to pass back + */ +typedef void (*vppcom_session_listener_errcb) (void *); + +/** + * @brief vppcom_session_register_listener accepts a bound session_index, and + * listens for connections. + * + * On successful connection, calls registered callback (cb) with new + * session_index. + * + * On error, calls registered error callback (errcb). + * + * @param session_index - bound session_index to create listener on + * @param cb - on new accepted session callback + * @param errcb - on failure callback + * @param flags - placeholder for future use. Must be ZERO + * @param q_len - max listener connection backlog + * @param ptr - user data + * @return + */ +extern int vppcom_session_register_listener (uint32_t session_index, + vppcom_session_listener_cb cb, + vppcom_session_listener_errcb + errcb, uint8_t flags, int q_len, + void *ptr); + /* TBD: make these constructor/destructor function */ extern int vppcom_app_create (char *app_name); extern void vppcom_app_destroy (void); -extern int vppcom_session_create (uint32_t vrf, uint8_t proto, - uint8_t is_nonblocking); +extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking); extern int vppcom_session_close (uint32_t session_index); extern int vppcom_session_bind (uint32_t session_index, vppcom_endpt_t * ep); extern int vppcom_session_listen (uint32_t session_index, uint32_t q_len); + extern int vppcom_session_accept (uint32_t session_index, vppcom_endpt_t * client_ep, uint32_t flags); @@ -244,6 +325,12 @@ extern int vppcom_session_sendto (uint32_t session_index, void *buffer, extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids, double wait_for_time); +/* *INDENT-OFF* */ +#ifdef __cplusplus +} +#endif +/* *INDENT-ON* */ + #endif /* included_vppcom_h */ /*