blob: e0afaa72670c9cd63ed555f86a67f960007ace9f (
plain)
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
|
//
// Copyright 2015 Google, Inc.
//
// 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.
//
#pragma once
#include <memory>
#include <bluetooth/uuid.h>
namespace bluetooth {
// Used for filtering scan results by allowing clients to restrict scan results
// to only those that are of interest to them.
class ScanFilter {
public:
ScanFilter() = default;
virtual ~ScanFilter() = default;
// Copy constructor and assignment operator.
ScanFilter(const ScanFilter& other);
ScanFilter& operator=(const ScanFilter& other);
// The device name used while filtering scan results.
const std::string& device_name() const { return device_name_; }
void set_device_name(const std::string& name) { device_name_ = name; }
// The device address used while filtering scan results. Address should be in
// the XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.
const std::string& device_address() const { return device_address_; }
// Sets the device address used for filtering. Returns false if
// |device_address| is in an illegal format.
bool SetDeviceAddress(const std::string& device_address);
// The service Uuid and its mask used while filtering scan results. See
// SetServiceUuidWithMask for what this mask does. The raw pointer returned
// from these getters belongs to the ScanFilter object. nullptr will be
// returned if these fields have not been set on this filter.
const Uuid* service_uuid() const { return service_uuid_.get(); }
const Uuid* service_uuid_mask() const { return service_uuid_mask_.get(); }
// Sets the service Uuid for this filter.
void SetServiceUuid(const Uuid& service_uuid);
// Sets the service Uuid for this filter with a 128-bit mask. The mask allows
// the caller to partially filter scanned service Uuids. For any of the
// 128-bits of a Uuid, set the corresponding bit in the mask to 1 to match the
// advertised value, and 0 to ignore that bit.
void SetServiceUuidWithMask(const Uuid& service_uuid, const Uuid& mask);
// Comparison operator.
bool operator==(const ScanFilter& rhs) const;
protected:
std::string device_name_;
std::string device_address_;
std::unique_ptr<Uuid> service_uuid_;
std::unique_ptr<Uuid> service_uuid_mask_;
// TODO(armansito): Add service and manufacturer data filter fields.
};
} // namespace bluetooth
|
