project for eddystone
Dependencies: BLE_API mbed nRF51822
Fork of BLE_URIBeacon by
Diff: ConfigParamsPersistence.h
- Revision:
- 16:1daa78939a3b
- Child:
- 17:e2c0a1696e39
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ConfigParamsPersistence.h Mon Mar 09 16:35:03 2015 +0000 @@ -0,0 +1,45 @@ +/* mbed Microcontroller Library + * Copyright (c) 2006-2015 ARM Limited + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef __BLE_CONFIG_PARAMS_PERSISTENCE_H__ +#define __BLE_CONFIG_PARAMS_PERSISTENCE_H__ + +#include "URIBeaconConfigService.h" + + +/** + * Generic API to load the URIBeacon configuration parameters from persistent + * storage. If persistent storage isn't available, the persistenceSignature + * member of params may be left un-initialized to the MAGIC, and this will cause + * a reset to default values. + * + * @param[out] paramsP + * The parameters to be filled in from persistence storage. + */ +void loadURIBeaconConfigParams(URIBeaconConfigService::Params_t *paramsP); + +/** + * Generic API to store the URIBeacon configuration parameters to persistent + * storage. It typically initializes the persistenceSignature member of the + * params to the MAGIC value to indicate persistence. + * + * @param[in/out] paramsP + * The params to be saved; persistenceSignature member gets + * updated if persistence is successful. + */ +void saveURIBeaconConfigParams(URIBeaconConfigService::Params_t *paramsP); + +#endif /* #ifndef __BLE_CONFIG_PARAMS_PERSISTENCE_H__*/