Cordio Stack and Cordio Profiles  r2p3-02rel0
tipc_api.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Time profile client.
6  *
7  * Copyright (c) 2011-2018 Arm Ltd. All Rights Reserved.
8  * Arm Ltd. confidential and proprietary.
9  *
10  * IMPORTANT. Your use of this file is governed by a Software License Agreement
11  * ("Agreement") that must be accepted in order to download or otherwise receive a
12  * copy of this file. You may not use or copy this file for any purpose other than
13  * as described in the Agreement. If you do not agree to all of the terms of the
14  * Agreement do not use this file and delete all copies in your possession or control;
15  * if you do not have a copy of the Agreement, you must contact Arm Ltd. prior
16  * to any use, copying or further distribution of this software.
17  */
18 /*************************************************************************************************/
19 #ifndef TIPC_API_H
20 #define TIPC_API_H
21 
22 #include "att_api.h"
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /*! \addtogroup TIME_PROFILE
29  * \{ */
30 
31 /**************************************************************************************************
32  Macros
33 **************************************************************************************************/
34 
35 /*! \brief Current Time service enumeration of handle indexes of characteristics to be discovered */
36 enum
37 {
38  TIPC_CTS_CT_HDL_IDX, /*!< \brief Current time */
39  TIPC_CTS_CT_CCC_HDL_IDX, /*!< \brief Current time client characteristic configuration descriptor */
40  TIPC_CTS_LTI_HDL_IDX, /*!< \brief Local time information */
41  TIPC_CTS_RTI_HDL_IDX, /*!< \brief Reference time information */
42  TIPC_CTS_HDL_LIST_LEN /*!< \brief Handle list length */
43 };
44 
45 /**************************************************************************************************
46  Function Declarations
47 **************************************************************************************************/
48 
49 /*************************************************************************************************/
50 /*!
51  * \brief Perform service and characteristic discovery for Current Time service. Parameter
52  * pHdlList must point to an array of length \ref TIPC_CTS_HDL_LIST_LEN. If discovery is
53  * successful the handles of discovered characteristics and descriptors will be set
54  * in pHdlList.
55  *
56  * \param connId Connection identifier.
57  * \param pHdlList Characteristic handle list.
58  *
59  * \return None.
60  */
61 /*************************************************************************************************/
62 void TipcCtsDiscover(dmConnId_t connId, uint16_t *pHdlList);
63 
64 /*************************************************************************************************/
65 /*!
66  * \brief Process a value received in an ATT read response, notification, or indication
67  * message. Parameter pHdlList must point to an array of length \ref TIPC_CTS_HDL_LIST_LEN.
68  * If the attribute handle of the message matches a handle in the handle list the value
69  * is processed, otherwise it is ignored.
70  *
71  * \param pHdlList Characteristic handle list.
72  * \param pMsg ATT callback message.
73  *
74  * \return \ref ATT_SUCCESS if handle is found, \ref ATT_ERR_NOT_FOUND otherwise.
75  */
76 /*************************************************************************************************/
78 
79 /*! \} */ /* TIME_PROFILE */
80 
81 #ifdef __cplusplus
82 };
83 #endif
84 
85 #endif /* TIPC_API_H */
Current time client characteristic configuration descriptor.
Definition: tipc_api.h:39
uint8_t dmConnId_t
Connection identifier.
Definition: dm_api.h:501
ATT callback event.
Definition: att_api.h:154
uint8_t TipcCtsValueUpdate(uint16_t *pHdlList, attEvt_t *pMsg)
Process a value received in an ATT read response, notification, or indication message. Parameter pHdlList must point to an array of length TIPC_CTS_HDL_LIST_LEN. If the attribute handle of the message matches a handle in the handle list the value is processed, otherwise it is ignored.
Local time information.
Definition: tipc_api.h:40
Handle list length.
Definition: tipc_api.h:42
Reference time information.
Definition: tipc_api.h:41
void TipcCtsDiscover(dmConnId_t connId, uint16_t *pHdlList)
Perform service and characteristic discovery for Current Time service. Parameter pHdlList must point ...
unsigned short uint16_t
Unsigned 16-bit value.
Definition: wsf_types.h:67
Current time.
Definition: tipc_api.h:38
Attribute protocol client and server API.
unsigned char uint8_t
Unsigned 8-bit value.
Definition: wsf_types.h:63