Add deprecated message to Gap::connect overload function

This commit is contained in:
Liyou Zhou 2015-12-22 12:59:45 +00:00
parent 7398a396d7
commit ec7df38a77
3 changed files with 34 additions and 5 deletions

View File

@ -24,6 +24,7 @@
#include "GapEvents.h" #include "GapEvents.h"
#include "CallChainOfFunctionPointersWithContext.h" #include "CallChainOfFunctionPointersWithContext.h"
#include "FunctionPointerWithContext.h" #include "FunctionPointerWithContext.h"
#include "deprecate.h"
/* Forward declarations for classes that will only be used for pointers or references in the following. */ /* Forward declarations for classes that will only be used for pointers or references in the following. */
class GapAdvertisingParams; class GapAdvertisingParams;
@ -51,13 +52,13 @@ public:
/** /**
* Address-type for BLEProtocol addresses. * Address-type for BLEProtocol addresses.
* @note: deprecated. Use BLEProtocol::AddressType_t instead. * \deprecated: Use BLEProtocol::AddressType_t instead.
* *
* DEPRECATION ALERT: The following constants have been left in their * DEPRECATION ALERT: The following constants have been left in their
* deprecated state to transparenly support existing applications which may * deprecated state to transparenly support existing applications which may
* have used Gap::ADDR_TYPE_*. * have used Gap::ADDR_TYPE_*.
*/ */
enum AddressTypeOverload_t { enum DeprecatedAddressType_t {
ADDR_TYPE_PUBLIC = BLEProtocol::AddressType::PUBLIC, ADDR_TYPE_PUBLIC = BLEProtocol::AddressType::PUBLIC,
ADDR_TYPE_RANDOM_STATIC = BLEProtocol::AddressType::RANDOM_STATIC, ADDR_TYPE_RANDOM_STATIC = BLEProtocol::AddressType::RANDOM_STATIC,
ADDR_TYPE_RANDOM_PRIVATE_RESOLVABLE = BLEProtocol::AddressType::RANDOM_PRIVATE_RESOLVABLE, ADDR_TYPE_RANDOM_PRIVATE_RESOLVABLE = BLEProtocol::AddressType::RANDOM_PRIVATE_RESOLVABLE,
@ -285,9 +286,10 @@ public:
* to maintain backward compatibility for change from Gap::AddressType_t to BLEProtocol::AddressType_t * to maintain backward compatibility for change from Gap::AddressType_t to BLEProtocol::AddressType_t
*/ */
ble_error_t connect(const BLEProtocol::Address_t peerAddr, ble_error_t connect(const BLEProtocol::Address_t peerAddr,
AddressTypeOverload_t peerAddrType, DeprecatedAddressType_t peerAddrType,
const ConnectionParams_t *connectionParams, const ConnectionParams_t *connectionParams,
const GapScanningParams *scanParams) { const GapScanningParams *scanParams)
__deprecated_message("Gap::DeprecatedAddressType_t is deprecated, use BLEProtocol::AddressType_t instead") {
return connect(peerAddr, (BLEProtocol::AddressType_t) peerAddrType, connectionParams, scanParams); return connect(peerAddr, (BLEProtocol::AddressType_t) peerAddrType, connectionParams, scanParams);
} }

26
ble/deprecate.h Normal file
View File

@ -0,0 +1,26 @@
/* mbed Microcontroller Library
* Copyright (c) 2006-2013 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 __DEPRECATE_H__
#define __DEPRECATE_H__
#ifdef YOTTA_CFG_MBED_OS
#include "compiler-polyfill/attributes.h"
#else
#define __deprecated_message
#endif
#endif

View File

@ -35,7 +35,8 @@
"mbed-classic": "~0.0.1" "mbed-classic": "~0.0.1"
}, },
"mbed-os": { "mbed-os": {
"mbed-drivers": "*" "mbed-drivers": "*",
"compilerpolyfill": "^1.2.1"
} }
} }
} }