TI BLE Stack API Documentation  2.03.06
Functions
GATT Server Sub-Procedure API Functions

Functions

bStatus_t GATT_Indication (uint16 connHandle, attHandleValueInd_t *pInd, uint8 authenticated, uint8 taskId)
 This sub-procedure is used when a server is configured to indicate a characteristic value to a client and expects an attribute protocol layer acknowledgement that the indication was successfully received. More...
 
bStatus_t GATT_Notification (uint16 connHandle, attHandleValueNoti_t *pNoti, uint8 authenticated)
 This sub-procedure is used when a server is configured to notify a characteristic value to a client without expecting any attribute protocol layer acknowledgement that the notification was successfully received. More...
 

Detailed Description

Function Documentation

§ GATT_Indication()

bStatus_t GATT_Indication ( uint16  connHandle,
attHandleValueInd_t pInd,
uint8  authenticated,
uint8  taskId 
)

This sub-procedure is used when a server is configured to indicate a characteristic value to a client and expects an attribute protocol layer acknowledgement that the indication was successfully received.

The ATT Handle Value Indication is used in this sub-procedure.

If the return status from this function is SUCCESS, the calling application task will receive an OSAL GATT_MSG_EVENT message. The type of the message will be ATT_HANDLE_VALUE_CFM.

Note: This sub-procedure is complete when ATT_HANDLE_VALUE_CFM (with SUCCESS or bleTimeout status) is received by the calling application task.

Parameters
connHandle- connection to use
pInd- pointer to indication to be sent
authenticated- whether an authenticated link is required 0x01: LE Legacy authenticated 0x02: Secure Connections authenticated
taskId- task to be notified of response
Returns
SUCCESS: Indication was sent successfully.
INVALIDPARAMETER: Invalid connection handle or request field.
MSG_BUFFER_NOT_AVAIL: No HCI buffer is available.
bleNotConnected: Connection is down.
blePending: A confirmation is pending with this client.
bleMemAllocError: Memory allocation error occurred.
bleTimeout: Previous transaction timed out.

§ GATT_Notification()

bStatus_t GATT_Notification ( uint16  connHandle,
attHandleValueNoti_t pNoti,
uint8  authenticated 
)

This sub-procedure is used when a server is configured to notify a characteristic value to a client without expecting any attribute protocol layer acknowledgement that the notification was successfully received.

The ATT Handle Value Notification is used in this sub-procedure.

Note: A notification may be sent at any time and does not invoke a confirmation.

No confirmation will be sent to the calling application task for this sub-procedure.

Parameters
connHandle- connection to use
pNoti- pointer to notification to be sent
authenticated- whether an authenticated link is required 0x01: LE Legacy authenticated 0x02: Secure Connections authenticated
Returns
SUCCESS: Notification was sent successfully.
INVALIDPARAMETER: Invalid connection handle or request field.
MSG_BUFFER_NOT_AVAIL: No HCI buffer is available.
bleNotConnected: Connection is down.
bleMemAllocError: Memory allocation error occurred.
bleTimeout: Previous transaction timed out.