1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/*
* Author: Sven Gothel <sgothel@jausoft.com>
* Copyright (c) 2020 Gothel Software e.K.
* Copyright (c) 2020 ZAFENA AB
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef BT_GATT_SERVICE_HPP_
#define BT_GATT_SERVICE_HPP_
#include <cstring>
#include <string>
#include <memory>
#include <cstdint>
#include <mutex>
#include <atomic>
#include <jau/java_uplink.hpp>
#include <jau/darray.hpp>
#include <jau/octets.hpp>
#include <jau/uuid.hpp>
#include "BTTypes0.hpp"
#include "ATTPDUTypes.hpp"
#include "BTTypes1.hpp"
#include "BTGattChar.hpp"
/**
* - - - - - - - - - - - - - - -
*
* Module GATTService:
*
* - BT Core Spec v5.2: Vol 3, Part G Generic Attribute Protocol (GATT)
* - BT Core Spec v5.2: Vol 3, Part G GATT: 2.6 GATT Profile Hierarchy
*/
namespace direct_bt {
class BTGattHandler; // forward
class BTDevice; // forward
/**
* Representing a Gatt Service object from the ::GATTRole::Client perspective.
*
* BT Core Spec v5.2: Vol 3, Part G GATT: 3.1 Service Definition
*
* Includes a complete [Primary] Service Declaration
* including its list of Characteristic Declarations,
* which also may include its client config if available.
*/
class BTGattService : public BTObject {
private:
/** Service's GATTHandler weak back-reference */
std::weak_ptr<BTGattHandler> wbr_handler;
std::string toShortString() const noexcept;
public:
const bool primary;
/**
* Service start handle
* <p>
* Attribute handles are unique for each device (server) (BT Core Spec v5.2: Vol 3, Part F Protocol..: 3.2.2 Attribute Handle).
* </p>
*/
const uint16_t handle;
/**
* Service end handle, inclusive.
* <p>
* Attribute handles are unique for each device (server) (BT Core Spec v5.2: Vol 3, Part F Protocol..: 3.2.2 Attribute Handle).
* </p>
*/
const uint16_t end_handle;
/** Service type UUID */
std::unique_ptr<const jau::uuid_t> type;
/** List of Characteristic Declarations as shared reference */
jau::darray<BTGattCharRef> characteristicList;
BTGattService(const std::shared_ptr<BTGattHandler> &handler_, const bool isPrimary_,
const uint16_t startHandle_, const uint16_t endHandle_, std::unique_ptr<const jau::uuid_t> && type_) noexcept
: wbr_handler(handler_), primary(isPrimary_), handle(startHandle_), end_handle(endHandle_), type(std::move(type_)), characteristicList() {
characteristicList.reserve(10);
}
std::string get_java_class() const noexcept override {
return java_class();
}
static std::string java_class() noexcept {
return std::string(JAVA_DBT_PACKAGE "DBTGattService");
}
std::shared_ptr<BTGattHandler> getGattHandlerUnchecked() const noexcept { return wbr_handler.lock(); }
std::shared_ptr<BTGattHandler> getGattHandlerChecked() const;
std::shared_ptr<BTDevice> getDeviceUnchecked() const noexcept;
std::shared_ptr<BTDevice> getDeviceChecked() const;
/**
* Find a BTGattChar by its char_uuid.
*
* @parameter char_uuid the jau::uuid_t of the desired BTGattChar, within this BTGattService.
* @return The matching characteristic or null if not found
*/
std::shared_ptr<BTGattChar> findGattChar(const jau::uuid_t& char_uuid) noexcept;
std::string toString() const noexcept override;
};
inline bool operator==(const BTGattService& lhs, const BTGattService& rhs) noexcept
{ return lhs.handle == rhs.handle && lhs.end_handle == rhs.end_handle; /** unique attribute handles */ }
inline bool operator!=(const BTGattService& lhs, const BTGattService& rhs) noexcept
{ return !(lhs == rhs); }
} // namespace direct_bt
#endif /* BT_GATT_SERVICE_HPP_ */
|
