EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

features/FEATURE_BLE/ble/BLETypes.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

UserRevisionLine numberNew contents of line
be_bryan 0:b74591d5ab33 1 /* mbed Microcontroller Library
be_bryan 0:b74591d5ab33 2 * Copyright (c) 2017-2017 ARM Limited
be_bryan 0:b74591d5ab33 3 *
be_bryan 0:b74591d5ab33 4 * Licensed under the Apache License, Version 2.0 (the "License");
be_bryan 0:b74591d5ab33 5 * you may not use this file except in compliance with the License.
be_bryan 0:b74591d5ab33 6 * You may obtain a copy of the License at
be_bryan 0:b74591d5ab33 7 *
be_bryan 0:b74591d5ab33 8 * http://www.apache.org/licenses/LICENSE-2.0
be_bryan 0:b74591d5ab33 9 *
be_bryan 0:b74591d5ab33 10 * Unless required by applicable law or agreed to in writing, software
be_bryan 0:b74591d5ab33 11 * distributed under the License is distributed on an "AS IS" BASIS,
be_bryan 0:b74591d5ab33 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
be_bryan 0:b74591d5ab33 13 * See the License for the specific language governing permissions and
be_bryan 0:b74591d5ab33 14 * limitations under the License.
be_bryan 0:b74591d5ab33 15 */
be_bryan 0:b74591d5ab33 16
be_bryan 0:b74591d5ab33 17 #ifndef BLE_TYPES_H_
be_bryan 0:b74591d5ab33 18 #define BLE_TYPES_H_
be_bryan 0:b74591d5ab33 19
be_bryan 0:b74591d5ab33 20 #include <stddef.h>
be_bryan 0:b74591d5ab33 21 #include <stdint.h>
be_bryan 0:b74591d5ab33 22
be_bryan 0:b74591d5ab33 23 /**
be_bryan 0:b74591d5ab33 24 * @addtogroup ble
be_bryan 0:b74591d5ab33 25 * @{
be_bryan 0:b74591d5ab33 26 * @addtogroup common
be_bryan 0:b74591d5ab33 27 * @{
be_bryan 0:b74591d5ab33 28 */
be_bryan 0:b74591d5ab33 29
be_bryan 0:b74591d5ab33 30 namespace ble {
be_bryan 0:b74591d5ab33 31
be_bryan 0:b74591d5ab33 32 /**
be_bryan 0:b74591d5ab33 33 * Opaque reference to a connection.
be_bryan 0:b74591d5ab33 34 *
be_bryan 0:b74591d5ab33 35 * Internally a connection handle is an unsigned integer capable of holding a
be_bryan 0:b74591d5ab33 36 * pointer.
be_bryan 0:b74591d5ab33 37 *
be_bryan 0:b74591d5ab33 38 * The real type (either a pointer to an object or an integer) is opaque for
be_bryan 0:b74591d5ab33 39 * users and platform dependent.
be_bryan 0:b74591d5ab33 40 */
be_bryan 0:b74591d5ab33 41 typedef uintptr_t connection_handle_t;
be_bryan 0:b74591d5ab33 42
be_bryan 0:b74591d5ab33 43 /**
be_bryan 0:b74591d5ab33 44 * Reference to an attribute in a GATT database.
be_bryan 0:b74591d5ab33 45 */
be_bryan 0:b74591d5ab33 46 typedef uint16_t attribute_handle_t;
be_bryan 0:b74591d5ab33 47
be_bryan 0:b74591d5ab33 48
be_bryan 0:b74591d5ab33 49 /**
be_bryan 0:b74591d5ab33 50 * Inclusive range of GATT attributes handles.
be_bryan 0:b74591d5ab33 51 *
be_bryan 0:b74591d5ab33 52 * @note Instances can be constructed with the help of the factory function
be_bryan 0:b74591d5ab33 53 * attribute_handle_range().
be_bryan 0:b74591d5ab33 54 */
be_bryan 0:b74591d5ab33 55 struct attribute_handle_range_t {
be_bryan 0:b74591d5ab33 56 /**
be_bryan 0:b74591d5ab33 57 * Begining of the range.
be_bryan 0:b74591d5ab33 58 */
be_bryan 0:b74591d5ab33 59 attribute_handle_t begin;
be_bryan 0:b74591d5ab33 60
be_bryan 0:b74591d5ab33 61 /**
be_bryan 0:b74591d5ab33 62 * End of the range.
be_bryan 0:b74591d5ab33 63 */
be_bryan 0:b74591d5ab33 64 attribute_handle_t end;
be_bryan 0:b74591d5ab33 65
be_bryan 0:b74591d5ab33 66 /**
be_bryan 0:b74591d5ab33 67 * Equal operator for attribute_handle_range_t.
be_bryan 0:b74591d5ab33 68 *
be_bryan 0:b74591d5ab33 69 * @param[in] lhs Left hand side of the expression.
be_bryan 0:b74591d5ab33 70 * @param[in] rhs Right hand side of the expression.
be_bryan 0:b74591d5ab33 71 *
be_bryan 0:b74591d5ab33 72 * @return true if lhs is equal to rhs and false otherwise.
be_bryan 0:b74591d5ab33 73 */
be_bryan 0:b74591d5ab33 74 friend bool operator==(
be_bryan 0:b74591d5ab33 75 const attribute_handle_range_t &lhs, const attribute_handle_range_t &rhs
be_bryan 0:b74591d5ab33 76 ) {
be_bryan 0:b74591d5ab33 77 return (lhs.begin == rhs.begin) && (lhs.end == rhs.end);
be_bryan 0:b74591d5ab33 78 }
be_bryan 0:b74591d5ab33 79
be_bryan 0:b74591d5ab33 80 /**
be_bryan 0:b74591d5ab33 81 * Not equal operator for attribute_handle_range_t.
be_bryan 0:b74591d5ab33 82 *
be_bryan 0:b74591d5ab33 83 * @param[in] lhs Left hand side of the expression.
be_bryan 0:b74591d5ab33 84 * @param[in] rhs Right hand side of the expression.
be_bryan 0:b74591d5ab33 85 *
be_bryan 0:b74591d5ab33 86 * @return true if lhs is not equal to rhs and false otherwise.
be_bryan 0:b74591d5ab33 87 */
be_bryan 0:b74591d5ab33 88 friend bool operator!=(
be_bryan 0:b74591d5ab33 89 const attribute_handle_range_t &lhs, const attribute_handle_range_t &rhs
be_bryan 0:b74591d5ab33 90 ) {
be_bryan 0:b74591d5ab33 91 return !(lhs == rhs);
be_bryan 0:b74591d5ab33 92 }
be_bryan 0:b74591d5ab33 93 };
be_bryan 0:b74591d5ab33 94
be_bryan 0:b74591d5ab33 95
be_bryan 0:b74591d5ab33 96 /**
be_bryan 0:b74591d5ab33 97 * Construct an attribute_handle_range_t from its first and last attribute handle.
be_bryan 0:b74591d5ab33 98 *
be_bryan 0:b74591d5ab33 99 * @param begin Handle at the begining of the range.
be_bryan 0:b74591d5ab33 100 * @param end Handle at the end of the range.
be_bryan 0:b74591d5ab33 101 *
be_bryan 0:b74591d5ab33 102 * @return An instance of attribute_handle_range_t where
be_bryan 0:b74591d5ab33 103 * attribute_handle_range_t::begin is equal to begin and
be_bryan 0:b74591d5ab33 104 * attribute_handle_range_t::end is equal to end.
be_bryan 0:b74591d5ab33 105 *
be_bryan 0:b74591d5ab33 106 * @note This function is defined instead of a constructor to keep "POD-ness"
be_bryan 0:b74591d5ab33 107 * of attribute_handle_range_t.
be_bryan 0:b74591d5ab33 108 */
be_bryan 0:b74591d5ab33 109 static inline attribute_handle_range_t attribute_handle_range(
be_bryan 0:b74591d5ab33 110 attribute_handle_t begin,
be_bryan 0:b74591d5ab33 111 attribute_handle_t end
be_bryan 0:b74591d5ab33 112 ) {
be_bryan 0:b74591d5ab33 113 attribute_handle_range_t result = {
be_bryan 0:b74591d5ab33 114 begin,
be_bryan 0:b74591d5ab33 115 end
be_bryan 0:b74591d5ab33 116 };
be_bryan 0:b74591d5ab33 117 return result;
be_bryan 0:b74591d5ab33 118 }
be_bryan 0:b74591d5ab33 119
be_bryan 0:b74591d5ab33 120 } // namespace ble
be_bryan 0:b74591d5ab33 121
be_bryan 0:b74591d5ab33 122 /**
be_bryan 0:b74591d5ab33 123 * @}
be_bryan 0:b74591d5ab33 124 * @}
be_bryan 0:b74591d5ab33 125 */
be_bryan 0:b74591d5ab33 126
be_bryan 0:b74591d5ab33 127 #endif /* BLE_TYPES_H_ */