Thomas Butler / nrf51-sdk

cvb

Fork of nrf51-sdk by Lancaster University

source/nordic_sdk/components/ble/peer_manager/peer_id.h@0:bc2961fa1ef0, 2016-04-06 (annotated)

Committer:
Jonathan Austin
Date:
Wed Apr 06 23:55:04 2016 +0100
Revision:
0:bc2961fa1ef0
Synchronized with git rev 90647e3

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jonathan Austin 0:bc2961fa1ef0 1 /*
Jonathan Austin 0:bc2961fa1ef0 2 * Copyright (c) Nordic Semiconductor ASA
Jonathan Austin 0:bc2961fa1ef0 3 * All rights reserved.
Jonathan Austin 0:bc2961fa1ef0 4 *
Jonathan Austin 0:bc2961fa1ef0 5 * Redistribution and use in source and binary forms, with or without modification,
Jonathan Austin 0:bc2961fa1ef0 6 * are permitted provided that the following conditions are met:
Jonathan Austin 0:bc2961fa1ef0 7 *
Jonathan Austin 0:bc2961fa1ef0 8 * 1. Redistributions of source code must retain the above copyright notice, this
Jonathan Austin 0:bc2961fa1ef0 9 * list of conditions and the following disclaimer.
Jonathan Austin 0:bc2961fa1ef0 10 *
Jonathan Austin 0:bc2961fa1ef0 11 * 2. Redistributions in binary form must reproduce the above copyright notice, this
Jonathan Austin 0:bc2961fa1ef0 12 * list of conditions and the following disclaimer in the documentation and/or
Jonathan Austin 0:bc2961fa1ef0 13 * other materials provided with the distribution.
Jonathan Austin 0:bc2961fa1ef0 14 *
Jonathan Austin 0:bc2961fa1ef0 15 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other
Jonathan Austin 0:bc2961fa1ef0 16 * contributors to this software may be used to endorse or promote products
Jonathan Austin 0:bc2961fa1ef0 17 * derived from this software without specific prior written permission.
Jonathan Austin 0:bc2961fa1ef0 18 *
Jonathan Austin 0:bc2961fa1ef0 19 *
Jonathan Austin 0:bc2961fa1ef0 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
Jonathan Austin 0:bc2961fa1ef0 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
Jonathan Austin 0:bc2961fa1ef0 22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Jonathan Austin 0:bc2961fa1ef0 23 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
Jonathan Austin 0:bc2961fa1ef0 24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
Jonathan Austin 0:bc2961fa1ef0 25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
Jonathan Austin 0:bc2961fa1ef0 26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
Jonathan Austin 0:bc2961fa1ef0 27 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Jonathan Austin 0:bc2961fa1ef0 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
Jonathan Austin 0:bc2961fa1ef0 29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Jonathan Austin 0:bc2961fa1ef0 30 *
Jonathan Austin 0:bc2961fa1ef0 31 */
Jonathan Austin 0:bc2961fa1ef0 32
Jonathan Austin 0:bc2961fa1ef0 33
Jonathan Austin 0:bc2961fa1ef0 34 #ifndef PEER_ID_H__
Jonathan Austin 0:bc2961fa1ef0 35 #define PEER_ID_H__
Jonathan Austin 0:bc2961fa1ef0 36
Jonathan Austin 0:bc2961fa1ef0 37
Jonathan Austin 0:bc2961fa1ef0 38 #include "stdint.h"
Jonathan Austin 0:bc2961fa1ef0 39 #include "sdk_errors.h"
Jonathan Austin 0:bc2961fa1ef0 40 #include "ble_gap.h"
Jonathan Austin 0:bc2961fa1ef0 41 #include "peer_manager_types.h"
Jonathan Austin 0:bc2961fa1ef0 42
Jonathan Austin 0:bc2961fa1ef0 43
Jonathan Austin 0:bc2961fa1ef0 44 /**
Jonathan Austin 0:bc2961fa1ef0 45 * @defgroup peer_id Peer IDs
Jonathan Austin 0:bc2961fa1ef0 46 * @ingroup peer_manager
Jonathan Austin 0:bc2961fa1ef0 47 * @{
Jonathan Austin 0:bc2961fa1ef0 48 * @brief An internal module of @ref peer_manager. This module keeps track of which peer IDs are in
Jonathan Austin 0:bc2961fa1ef0 49 * use and which are free.
Jonathan Austin 0:bc2961fa1ef0 50 */
Jonathan Austin 0:bc2961fa1ef0 51
Jonathan Austin 0:bc2961fa1ef0 52
Jonathan Austin 0:bc2961fa1ef0 53 /**@brief Function for initializing the module.
Jonathan Austin 0:bc2961fa1ef0 54 */
Jonathan Austin 0:bc2961fa1ef0 55 void peer_id_init(void);
Jonathan Austin 0:bc2961fa1ef0 56
Jonathan Austin 0:bc2961fa1ef0 57
Jonathan Austin 0:bc2961fa1ef0 58 /**@brief Function for claiming an unused peer ID.
Jonathan Austin 0:bc2961fa1ef0 59 *
Jonathan Austin 0:bc2961fa1ef0 60 * @param peer_id The peer ID to allocate. If this is @ref PM_PEER_ID_INVALID, the first available
Jonathan Austin 0:bc2961fa1ef0 61 * will be allocated.
Jonathan Austin 0:bc2961fa1ef0 62 *
Jonathan Austin 0:bc2961fa1ef0 63 * @return The allocated peer ID.
Jonathan Austin 0:bc2961fa1ef0 64 * @retval PM_PEER_ID_INVALID If no peer ID could be allocated or module is not initialized.
Jonathan Austin 0:bc2961fa1ef0 65 */
Jonathan Austin 0:bc2961fa1ef0 66 pm_peer_id_t peer_id_allocate(pm_peer_id_t peer_id);
Jonathan Austin 0:bc2961fa1ef0 67
Jonathan Austin 0:bc2961fa1ef0 68
Jonathan Austin 0:bc2961fa1ef0 69 /**@brief Function for freeing a peer ID and clearing all data associated with it in persistent
Jonathan Austin 0:bc2961fa1ef0 70 * storage.
Jonathan Austin 0:bc2961fa1ef0 71 *
Jonathan Austin 0:bc2961fa1ef0 72 * @param[in] peer_id Peer ID to free.
Jonathan Austin 0:bc2961fa1ef0 73 */
Jonathan Austin 0:bc2961fa1ef0 74 void peer_id_free(pm_peer_id_t peer_id);
Jonathan Austin 0:bc2961fa1ef0 75
Jonathan Austin 0:bc2961fa1ef0 76
Jonathan Austin 0:bc2961fa1ef0 77 /**@brief Function for finding out whether a peer ID is in use.
Jonathan Austin 0:bc2961fa1ef0 78 *
Jonathan Austin 0:bc2961fa1ef0 79 * @param[in] peer_id The peer ID to inquire about.
Jonathan Austin 0:bc2961fa1ef0 80 *
Jonathan Austin 0:bc2961fa1ef0 81 * @retval true peer_id is in use.
Jonathan Austin 0:bc2961fa1ef0 82 * @retval false peer_id is free, or the module is not initialized.
Jonathan Austin 0:bc2961fa1ef0 83 */
Jonathan Austin 0:bc2961fa1ef0 84 bool peer_id_is_allocated(pm_peer_id_t peer_id);
Jonathan Austin 0:bc2961fa1ef0 85
Jonathan Austin 0:bc2961fa1ef0 86
Jonathan Austin 0:bc2961fa1ef0 87 /**@brief Function for getting the next peer ID in the sequence of all used peer IDs. Can be
Jonathan Austin 0:bc2961fa1ef0 88 * used to loop through all used peer IDs.
Jonathan Austin 0:bc2961fa1ef0 89 *
Jonathan Austin 0:bc2961fa1ef0 90 * @note @ref PM_PEER_ID_INVALID is considered to be before the first and after the last ordinary
Jonathan Austin 0:bc2961fa1ef0 91 * peer ID.
Jonathan Austin 0:bc2961fa1ef0 92 *
Jonathan Austin 0:bc2961fa1ef0 93 * @param[in] prev_peer_id The previous peer ID.
Jonathan Austin 0:bc2961fa1ef0 94 *
Jonathan Austin 0:bc2961fa1ef0 95 * @return The next peer ID.
Jonathan Austin 0:bc2961fa1ef0 96 * @return The first used peer ID if prev_peer_id was @ref PM_PEER_ID_INVALID.
Jonathan Austin 0:bc2961fa1ef0 97 * @retval PM_PEER_ID_INVALID if prev_peer_id was the last ordinary peer ID or the module is
Jonathan Austin 0:bc2961fa1ef0 98 * not initialized.
Jonathan Austin 0:bc2961fa1ef0 99 */
Jonathan Austin 0:bc2961fa1ef0 100 pm_peer_id_t peer_id_next_id_get(pm_peer_id_t prev_peer_id);
Jonathan Austin 0:bc2961fa1ef0 101
Jonathan Austin 0:bc2961fa1ef0 102
Jonathan Austin 0:bc2961fa1ef0 103 /**@brief Function for querying the number of valid peer IDs available. I.E the number of peers
Jonathan Austin 0:bc2961fa1ef0 104 * in persistent storage.
Jonathan Austin 0:bc2961fa1ef0 105 *
Jonathan Austin 0:bc2961fa1ef0 106 * @return The number of valid peer IDs, or 0 if module is not initialized.
Jonathan Austin 0:bc2961fa1ef0 107 */
Jonathan Austin 0:bc2961fa1ef0 108 uint32_t peer_id_n_ids(void);
Jonathan Austin 0:bc2961fa1ef0 109
Jonathan Austin 0:bc2961fa1ef0 110 /** @} */
Jonathan Austin 0:bc2961fa1ef0 111
Jonathan Austin 0:bc2961fa1ef0 112 #endif /* PEER_ID_H__ */