mbed-os-examples / Mbed OS mbed-os-example-ble-EddystoneService

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

source/PersistentStorageHelper/ConfigParamsPersistence.h@1:9db4d46bb63f, 2016-07-28 (annotated)

Committer:
mbed_official
Date:
Thu Jul 28 23:14:36 2016 +0100
Revision:
1:9db4d46bb63f
Parent:
0:4c8f8bf32a99
Child:
2:9ee673e0b86a
Merge branch 'master' of https://github.com/ARMmbed/mbed-os-example-ble





Commit copied from ./src/github.com/ARMmbed/mbed-os-example-ble

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 1:9db4d46bb63f 1 /* mbed Microcontroller Library
mbed_official 1:9db4d46bb63f 2 * Copyright (c) 2006-2015 ARM Limited
mbed_official 1:9db4d46bb63f 3 *
mbed_official 1:9db4d46bb63f 4 * Licensed under the Apache License, Version 2.0 (the "License");
mbed_official 1:9db4d46bb63f 5 * you may not use this file except in compliance with the License.
mbed_official 1:9db4d46bb63f 6 * You may obtain a copy of the License at
mbed_official 1:9db4d46bb63f 7 *
mbed_official 1:9db4d46bb63f 8 * http://www.apache.org/licenses/LICENSE-2.0
mbed_official 1:9db4d46bb63f 9 *
mbed_official 1:9db4d46bb63f 10 * Unless required by applicable law or agreed to in writing, software
mbed_official 1:9db4d46bb63f 11 * distributed under the License is distributed on an "AS IS" BASIS,
mbed_official 1:9db4d46bb63f 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mbed_official 1:9db4d46bb63f 13 * See the License for the specific language governing permissions and
mbed_official 1:9db4d46bb63f 14 * limitations under the License.
mbed_official 1:9db4d46bb63f 15 */
mbed_official 1:9db4d46bb63f 16
mbed_official 1:9db4d46bb63f 17 #ifndef __BLE_CONFIG_PARAMS_PERSISTENCE_H__
mbed_official 1:9db4d46bb63f 18 #define __BLE_CONFIG_PARAMS_PERSISTENCE_H__
mbed_official 1:9db4d46bb63f 19
mbed_official 1:9db4d46bb63f 20 #include "../EddystoneService.h"
mbed_official 1:9db4d46bb63f 21
mbed_official 1:9db4d46bb63f 22 /**
mbed_official 1:9db4d46bb63f 23 * Generic API to load the Eddystone Service configuration parameters from persistent
mbed_official 1:9db4d46bb63f 24 * storage. If persistent storage isn't available, the persistenceSignature
mbed_official 1:9db4d46bb63f 25 * member of params may be left un-initialized to the MAGIC, and this will cause
mbed_official 1:9db4d46bb63f 26 * a reset to default values.
mbed_official 1:9db4d46bb63f 27 *
mbed_official 1:9db4d46bb63f 28 * @param[out] paramsP
mbed_official 1:9db4d46bb63f 29 * The parameters to be filled in from persistence storage. This
mbed_official 1:9db4d46bb63f 30 * argument can be NULL if the caller is only interested in
mbed_official 1:9db4d46bb63f 31 * discovering the persistence status of params.
mbed_official 1:9db4d46bb63f 32 *
mbed_official 1:9db4d46bb63f 33 * @return true if params were loaded from persistent storage and have usefully
mbed_official 1:9db4d46bb63f 34 * initialized fields.
mbed_official 1:9db4d46bb63f 35 */
mbed_official 1:9db4d46bb63f 36 bool loadEddystoneServiceConfigParams(EddystoneService::EddystoneParams_t *paramsP);
mbed_official 1:9db4d46bb63f 37
mbed_official 1:9db4d46bb63f 38 /**
mbed_official 1:9db4d46bb63f 39 * Generic API to store the Eddystone Service configuration parameters to persistent
mbed_official 1:9db4d46bb63f 40 * storage. It typically initializes the persistenceSignature member of the
mbed_official 1:9db4d46bb63f 41 * params to the MAGIC value to indicate persistence.
mbed_official 1:9db4d46bb63f 42 *
mbed_official 1:9db4d46bb63f 43 * @param[in,out] paramsP
mbed_official 1:9db4d46bb63f 44 * The params to be saved; persistenceSignature member gets
mbed_official 1:9db4d46bb63f 45 * updated if persistence is successful.
mbed_official 1:9db4d46bb63f 46 *
mbed_official 1:9db4d46bb63f 47 * @note The save operation may be asynchronous. It may be a short while before
mbed_official 1:9db4d46bb63f 48 * the request takes affect. Reading back saved configParams may not yield
mbed_official 1:9db4d46bb63f 49 * correct behaviour if attempted soon after a store.
mbed_official 1:9db4d46bb63f 50 */
mbed_official 1:9db4d46bb63f 51 void saveEddystoneServiceConfigParams(const EddystoneService::EddystoneParams_t *paramsP);
mbed_official 1:9db4d46bb63f 52
mbed_official 1:9db4d46bb63f 53 #endif /* #ifndef __BLE_CONFIG_PARAMS_PERSISTENCE_H__*/