xApp dev API

The following functions are available in the dev SDK.

// Function to call at initialization with the configuration file path
// @param1:id := configuration file path 
void init_xapp_api(const char* conf_file);

// Function to stop the SDK 
// @return := whether the stop operation succeed or not
bool try_stop_xapp_api(void);    

// Function to get connected E2 Nodes
// @return := connected E2 Nodes
e2_node_arr_xapp_t e2_nodes_xapp_api(void);
  
// Function to subscribe to RAN Function 
// @param1:id := Global E2 Node
// @param2:rf := RAN Function ID
// @param3:data := Subscription data e.g., kpm_sub_data_t  
// @param4:handle := Callback function pointer
// @return := Answer whether the subscription was successfull and a handle to identify the subscription ID.
sm_ans_xapp_t report_sm_xapp_api(global_e2_node_id_t* id, uint32_t rf_id, void* data, sm_cb handler);

// Function to remove the handle previously returned
// @param1:handle := Handle previously returned in a successfull subscription 
void rm_report_sm_xapp_api(int const handle);

// Function to send a control message
// @param1:id := Global E2 Node
// @param2:rf := RAN Function ID
// @param3:wr := Control request data e.g., ccc_ctrl_req_data_t 
// @return := Answer whether the control message was successfull and a handle to identify the message ID.
sm_ans_xapp_t control_sm_xapp_api(global_e2_node_id_t* id, uint32_t rf_id, void* wr);