Cordio Stack and Cordio Profiles  r2p3-02rel0
scpps_api.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3 * \file
4 *
5 * \brief Scan Parameter Profile Server Application Interface.
6 *
7 * Copyright (c) 2016-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 
20 #ifndef SCPPS_API_H
21 #define SCPPS_API_H
22 
23 #include "att_api.h"
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
29 /*! \addtogroup SCAN_PARAMETER_PROFILE
30  * \{ */
31 
32 /**************************************************************************************************
33  Function Declarations
34 **************************************************************************************************/
35 
36 /*! \brief Application interval window callback */
37 typedef void ScppsAppCback_t(dmConnId_t connId, uint16_t interval, uint16_t window);
38 
39 /*************************************************************************************************/
40 /*!
41  * \brief Called to register an application scan interval window callback function
42  *
43  * \param cback Application interval window callback
44  *
45  * \return Status
46  */
47 /*************************************************************************************************/
49 
50 /*************************************************************************************************/
51 /*!
52  * \brief Called when the peer writes to SCPPS attributes
53  *
54  * \param connId DM connection identifier.
55  * \param handle ATT handle.
56  * \param operation ATT operation.
57  * \param offset Write offset.
58  * \param len Write length.
59  * \param pValue Value to write.
60  * \param pAttr Attribute to write.
61  *
62  * \return Status
63  */
64 /*************************************************************************************************/
65 uint8_t ScppsAttsWriteCback(dmConnId_t connId, uint16_t handle, uint8_t operation,
66  uint16_t offset, uint16_t len, uint8_t *pValue, attsAttr_t *pAttr);
67 
68 /*! \} */ /* SCAN_PARAMETER_PROFILE */
69 
70 #ifdef __cplusplus
71 };
72 #endif
73 
74 #endif /* SCPPS_API_H */
uint8_t dmConnId_t
Connection identifier.
Definition: dm_api.h:501
void ScppsRegisterCback(ScppsAppCback_t *cback)
Called to register an application scan interval window callback function.
void ScppsAppCback_t(dmConnId_t connId, uint16_t interval, uint16_t window)
Application interval window callback.
Definition: scpps_api.h:37
uint8_t ScppsAttsWriteCback(dmConnId_t connId, uint16_t handle, uint8_t operation, uint16_t offset, uint16_t len, uint8_t *pValue, attsAttr_t *pAttr)
Called when the peer writes to SCPPS attributes.
Attribute structure.
Definition: att_api.h:186
unsigned short uint16_t
Unsigned 16-bit value.
Definition: wsf_types.h:67
Attribute protocol client and server API.
unsigned char uint8_t
Unsigned 8-bit value.
Definition: wsf_types.h:63