99 lines
3.3 KiB
C++
99 lines
3.3 KiB
C++
/*
|
|
* 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 "l2cap/le/link_options.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;
|
|
|
|
/**
|
|
* 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;
|
|
|
|
/**
|
|
* Get the Proxy for L2CAP Link Options.
|
|
* Only few special L2CAP users need to use it, including
|
|
* GATT, HID Device, Security Manager, and Java API.
|
|
*/
|
|
LinkOptions* GetLinkOptions();
|
|
|
|
private:
|
|
std::shared_ptr<internal::FixedChannelImpl> impl_;
|
|
os::Handler* l2cap_handler_;
|
|
};
|
|
|
|
} // namespace le
|
|
} // namespace l2cap
|
|
} // namespace bluetooth
|