Cascoda SDK
Cascoda SDK for building software to run with CA-821x transceivers
ca821x_api_callbacks Struct Reference

API user callbacks structure. More...

#include <ca821x-api/include/ca821x_api.h>

Collaboration diagram for ca821x_api_callbacks:

Public Attributes

MCPS_DATA_indication_callback MCPS_DATA_indication
 
MCPS_DATA_confirm_callback MCPS_DATA_confirm
 
MLME_ASSOCIATE_indication_callback MLME_ASSOCIATE_indication
 
MLME_ASSOCIATE_confirm_callback MLME_ASSOCIATE_confirm
 
MLME_DISASSOCIATE_indication_callback MLME_DISASSOCIATE_indication
 
MLME_DISASSOCIATE_confirm_callback MLME_DISASSOCIATE_confirm
 
MLME_BEACON_NOTIFY_indication_callback MLME_BEACON_NOTIFY_indication
 
MLME_ORPHAN_indication_callback MLME_ORPHAN_indication
 
MLME_SCAN_confirm_callback MLME_SCAN_confirm
 
MLME_COMM_STATUS_indication_callback MLME_COMM_STATUS_indication
 
MLME_SYNC_LOSS_indication_callback MLME_SYNC_LOSS_indication
 
HWME_WAKEUP_indication_callback HWME_WAKEUP_indication
 
TDME_RXPKT_indication_callback TDME_RXPKT_indication
 
TDME_EDDET_indication_callback TDME_EDDET_indication
 
TDME_ERROR_indication_callback TDME_ERROR_indication
 
ca_error(* generic_dispatch )(const struct MAC_Message *msg, struct ca821x_dev *pDeviceRef)
 

Detailed Description

API user callbacks structure.

Contains a set of function pointers that can (and should) be populated by the user for processing asynchronous messages received from the hardware. If the pointer for the specific command type is populated that will be called, otherwise the generic_dispatch function will be. If neither are populated the message is discarded.

Every callback should return:

  • CA_ERROR_NOT_HANDLED if the command was not handled, ie the command was unexpected/generated by another application etc.
  • CA_ERROR_SUCCESS if the command was successfully handled by the application.
  • Another CA_ERROR_ code if encountered.

Member Data Documentation

◆ generic_dispatch

ca_error(* ca821x_api_callbacks::generic_dispatch) (const struct MAC_Message *msg, struct ca821x_dev *pDeviceRef)

◆ HWME_WAKEUP_indication

HWME_WAKEUP_indication_callback ca821x_api_callbacks::HWME_WAKEUP_indication

◆ MCPS_DATA_confirm

MCPS_DATA_confirm_callback ca821x_api_callbacks::MCPS_DATA_confirm

◆ MCPS_DATA_indication

MCPS_DATA_indication_callback ca821x_api_callbacks::MCPS_DATA_indication

◆ MLME_ASSOCIATE_confirm

MLME_ASSOCIATE_confirm_callback ca821x_api_callbacks::MLME_ASSOCIATE_confirm

◆ MLME_ASSOCIATE_indication

MLME_ASSOCIATE_indication_callback ca821x_api_callbacks::MLME_ASSOCIATE_indication

◆ MLME_BEACON_NOTIFY_indication

MLME_BEACON_NOTIFY_indication_callback ca821x_api_callbacks::MLME_BEACON_NOTIFY_indication

◆ MLME_COMM_STATUS_indication

MLME_COMM_STATUS_indication_callback ca821x_api_callbacks::MLME_COMM_STATUS_indication

◆ MLME_DISASSOCIATE_confirm

MLME_DISASSOCIATE_confirm_callback ca821x_api_callbacks::MLME_DISASSOCIATE_confirm

◆ MLME_DISASSOCIATE_indication

MLME_DISASSOCIATE_indication_callback ca821x_api_callbacks::MLME_DISASSOCIATE_indication

◆ MLME_ORPHAN_indication

MLME_ORPHAN_indication_callback ca821x_api_callbacks::MLME_ORPHAN_indication

◆ MLME_SCAN_confirm

MLME_SCAN_confirm_callback ca821x_api_callbacks::MLME_SCAN_confirm

◆ MLME_SYNC_LOSS_indication

MLME_SYNC_LOSS_indication_callback ca821x_api_callbacks::MLME_SYNC_LOSS_indication

◆ TDME_EDDET_indication

TDME_EDDET_indication_callback ca821x_api_callbacks::TDME_EDDET_indication

◆ TDME_ERROR_indication

TDME_ERROR_indication_callback ca821x_api_callbacks::TDME_ERROR_indication

◆ TDME_RXPKT_indication

TDME_RXPKT_indication_callback ca821x_api_callbacks::TDME_RXPKT_indication

The documentation for this struct was generated from the following file: