1.1.4.4.21 DRV_RF215_TX_CFM_CALLBACK Typedef

C

typedef void ( *DRV_RF215_TX_CFM_CALLBACK ) (
    DRV_RF215_TX_HANDLE txHandle,
    DRV_RF215_TX_CONFIRM_OBJ *cfmObj,
    uintptr_t context
);

Summary

Pointer to a RF215 driver transmit confirm callback function.

Description

This data type defines the required function signature for the RF215 driver transmit confirm event handling callback function. A client uses DRV_RF215_TxCfmCallbackRegister to register a pointer to a function which must match the signature (parameter and return value types) specified by this data type.

Parameters

ParamDescription
txHandleTransmission handle returned from DRV_RF215_TxRequest.
cfmObjPointer to the object containing the data associated to the transmit confirm (see DRV_RF215_TX_CONFIRM_OBJ).
contextValue identifying the context of the application that registered the callback function.

Returns

None.

Example

static void _APP_RF_TxCfmCb (
    DRV_RF215_TX_HANDLE txHandle,
    DRV_RF215_TX_CONFIRM_OBJ *cfmObj,
    uintptr_t ctxt
)
{
    // The context handle was set to an application specific object
    // It is now retrievable easily in the event handler
    MY_APP_OBJ myAppObj = (MY_APP_OBJ *) ctxt;

    // Transmission confirmation handling here.
}

DRV_HANDLE drvRf215Handle; // Returned from DRV_RF215_Open
MY_APP_OBJ myAppObj; // Application specific data object

DRV_RF215_TxCfmCallbackRegister(drvRf215Handle, _APP_RF_TxCfmCb,
    (uintptr_t) myAppObj);

Remarks

The context parameter contains a handle to the client context, provided at the time the callback function was registered using DRV_RF215_TxCfmCallbackRegister. This context value is passed back to the client as parameter. It can be any value necessary to identify the client context or instance (such as a pointer to the client's data) of the client that registered the callback.