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
|
/*
* Copyright 2019 The Android Open Source Project
*
* 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 "common/bidi_queue.h"
#include "common/callback.h"
#include "hci/acl_manager.h"
#include "l2cap/cid.h"
#include "os/handler.h"
#include "packet/base_packet_builder.h"
#include "packet/packet_view.h"
namespace bluetooth {
namespace l2cap {
namespace le {
namespace internal {
class FixedChannelImpl;
} // namespace internal
/**
* L2CAP fixed channel object. When a new object is created, it must be
* acquired through calling {@link FixedChannel#Acquire()} within X seconds.
* Otherwise, {@link FixedChannel#Release()} will be called automatically.
*
*/
class FixedChannel {
public:
// Should only be constructed by modules that have access to LinkManager
FixedChannel(std::shared_ptr<internal::FixedChannelImpl> impl, os::Handler* l2cap_handler)
: impl_(std::move(impl)), l2cap_handler_(l2cap_handler) {
ASSERT(impl_ != nullptr);
ASSERT(l2cap_handler_ != nullptr);
}
hci::AddressWithType GetDevice() const;
/**
* Return the role we have in the associated link
*/
hci::Role GetRole() const;
hci::AclConnection* GetAclConnection() const;
/**
* Register close callback. If close callback is registered, when a channel is closed, the channel's resource will
* only be freed after on_close callback is invoked. Otherwise, if no on_close callback is registered, the channel's
* resource will be freed immediately after closing.
*
* @param user_handler The handler used to invoke the callback on
* @param on_close_callback The callback invoked upon channel closing.
*/
using OnCloseCallback = common::OnceCallback<void(hci::ErrorCode)>;
void RegisterOnCloseCallback(os::Handler* user_handler, OnCloseCallback on_close_callback);
/**
* Indicate that this Fixed Channel is being used. This will prevent ACL connection from being disconnected.
*/
void Acquire();
/**
* Indicate that this Fixed Channel is no longer being used. ACL connection will be disconnected after
* kLinkIdleDisconnectTimeout if no other DynamicChannel is connected or no other Fixed Channel is using this
* ACL connection. However a module can still receive data on this channel as long as it remains open.
*/
void Release();
/**
* This method will retrieve the data channel queue to send and receive packets.
*
* {@see BidiQueueEnd}
*
* @return The upper end of a bi-directional queue.
*/
common::BidiQueueEnd<packet::BasePacketBuilder, packet::PacketView<packet::kLittleEndian>>* GetQueueUpEnd() const;
private:
std::shared_ptr<internal::FixedChannelImpl> impl_;
os::Handler* l2cap_handler_;
};
} // namespace le
} // namespace l2cap
} // namespace bluetooth
|
