NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_sta_event.h File Reference
#include <stdint.h>
#include <stdbool.h>
#include <doca_error.h>
#include <doca_types.h>
#include <doca_sta_handle.h>
Include dependency graph for doca_sta_event.h:

Go to the source code of this file.

Typedefs

typedef void(* doca_sta_event_transport_err_cb_t) (const struct doca_sta_event_transport_err *event, union doca_data user_data)
 Function to execute on STA event notification. More...
 
typedef void(* doca_sta_event_be_timeout_cb_t) (const struct doca_sta_event_be_timeout *event, union doca_data user_data)
 
typedef void(* doca_sta_event_eu_err_cb_t) (const struct doca_sta_event_eu_err *event, union doca_data user_data)
 

Functions

DOCA_EXPERIMENTAL doca_error_t doca_sta_event_transport_err_get_qp_handle (const struct doca_sta_event_transport_err *event, const struct doca_sta_qp_handle **qp_handle)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_event_transport_err_get_operation (const struct doca_sta_event_transport_err *event, uint32_t *operation)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_event_transport_err_get_syndrome (const struct doca_sta_event_transport_err *event, uint32_t *syndrome)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_event_transport_err_get_vendor_syndrome (const struct doca_sta_event_transport_err *event, uint32_t *vendor_syndrome)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_io_event_transport_err_register_cb (struct doca_sta_io *sta_io, doca_sta_event_transport_err_cb_t event_cb, union doca_data user_data)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_event_be_timeout_register_cb (struct doca_sta *sta, doca_sta_event_be_timeout_cb_t event_cb, union doca_data user_data)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_event_be_timeout_get_be_handle (const struct doca_sta_event_be_timeout *event, const struct doca_sta_be_handle **be_handle)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_event_be_timeout_get_be_queue_handle (const struct doca_sta_event_be_timeout *event, const struct doca_sta_be_q_handle **be_queue_handle)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_event_eu_err_register_cb (struct doca_sta *sta, doca_sta_event_eu_err_cb_t event_cb, union doca_data user_data)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_event_eu_err_is_fatal_error (const struct doca_sta_event_eu_err *event, bool *is_fatal_error)
 
DOCA_EXPERIMENTAL doca_error_t doca_sta_event_eu_err_get_eu_handle (const struct doca_sta_event_eu_err *event, const struct doca_sta_eu_handle **eu_handle)
 

Typedef Documentation

◆ doca_sta_event_be_timeout_cb_t

typedef void(* doca_sta_event_be_timeout_cb_t) (const struct doca_sta_event_be_timeout *event, union doca_data user_data)

Definition at line 75 of file doca_sta_event.h.

◆ doca_sta_event_eu_err_cb_t

typedef void(* doca_sta_event_eu_err_cb_t) (const struct doca_sta_event_eu_err *event, union doca_data user_data)

Definition at line 93 of file doca_sta_event.h.

◆ doca_sta_event_transport_err_cb_t

typedef void(* doca_sta_event_transport_err_cb_t) (const struct doca_sta_event_transport_err *event, union doca_data user_data)

Function to execute on STA event notification.

This function is called by doca_pe_progress() when related task received an event notification from DPA.

NOTE: the RDMA error events will be notified in the context of the doca_sta_io thread(s). The same doca_sta_io thread that initiated connect for the QP. The time-out events will be notified in the context of the doca_sta thread.

Parameters
[in]eventSTA event.
[in]user_dataThe user data parameter specified during call to doca_sta_event_register_cb API.

Definition at line 49 of file doca_sta_event.h.

Function Documentation

◆ doca_sta_event_be_timeout_get_be_handle()

DOCA_EXPERIMENTAL doca_error_t doca_sta_event_be_timeout_get_be_handle ( const struct doca_sta_event_be_timeout *  event,
const struct doca_sta_be_handle **  be_handle 
)

◆ doca_sta_event_be_timeout_get_be_queue_handle()

DOCA_EXPERIMENTAL doca_error_t doca_sta_event_be_timeout_get_be_queue_handle ( const struct doca_sta_event_be_timeout *  event,
const struct doca_sta_be_q_handle **  be_queue_handle 
)

◆ doca_sta_event_be_timeout_register_cb()

DOCA_EXPERIMENTAL doca_error_t doca_sta_event_be_timeout_register_cb ( struct doca_sta *  sta,
doca_sta_event_be_timeout_cb_t  event_cb,
union doca_data  user_data 
)

◆ doca_sta_event_eu_err_get_eu_handle()

DOCA_EXPERIMENTAL doca_error_t doca_sta_event_eu_err_get_eu_handle ( const struct doca_sta_event_eu_err *  event,
const struct doca_sta_eu_handle **  eu_handle 
)

◆ doca_sta_event_eu_err_is_fatal_error()

DOCA_EXPERIMENTAL doca_error_t doca_sta_event_eu_err_is_fatal_error ( const struct doca_sta_event_eu_err *  event,
bool is_fatal_error 
)

◆ doca_sta_event_eu_err_register_cb()

DOCA_EXPERIMENTAL doca_error_t doca_sta_event_eu_err_register_cb ( struct doca_sta *  sta,
doca_sta_event_eu_err_cb_t  event_cb,
union doca_data  user_data 
)

◆ doca_sta_event_transport_err_get_operation()

DOCA_EXPERIMENTAL doca_error_t doca_sta_event_transport_err_get_operation ( const struct doca_sta_event_transport_err *  event,
uint32_t *  operation 
)

◆ doca_sta_event_transport_err_get_qp_handle()

DOCA_EXPERIMENTAL doca_error_t doca_sta_event_transport_err_get_qp_handle ( const struct doca_sta_event_transport_err *  event,
const struct doca_sta_qp_handle **  qp_handle 
)

◆ doca_sta_event_transport_err_get_syndrome()

DOCA_EXPERIMENTAL doca_error_t doca_sta_event_transport_err_get_syndrome ( const struct doca_sta_event_transport_err *  event,
uint32_t *  syndrome 
)

◆ doca_sta_event_transport_err_get_vendor_syndrome()

DOCA_EXPERIMENTAL doca_error_t doca_sta_event_transport_err_get_vendor_syndrome ( const struct doca_sta_event_transport_err *  event,
uint32_t *  vendor_syndrome 
)

◆ doca_sta_io_event_transport_err_register_cb()

DOCA_EXPERIMENTAL doca_error_t doca_sta_io_event_transport_err_register_cb ( struct doca_sta_io *  sta_io,
doca_sta_event_transport_err_cb_t  event_cb,
union doca_data  user_data 
)