connection2.h

// Copyright 2024 The Pigweed Authors
//
// 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
//
//     https://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 "pw_async2/dispatcher.h"
#include "pw_bluetooth/gatt/client2.h"
#include "pw_bluetooth/internal/raii_ptr.h"
#include "pw_bluetooth/low_energy/channel.h"
#include "pw_bluetooth/types.h"
 
namespace pw::bluetooth::low_energy {
 
class Connection2 {
 public:
  enum class ConnectionParameterUpdateError : uint8_t {
    kFailure,
    kInvalidParameters,
    kRejected,
  };
 
  enum class DisconnectReason : uint8_t {
    kFailure,
    kRemoteUserTerminatedConnection,
    kConnectionTimeout,
  };
 
  struct ConnectionParameters {
    uint16_t interval;
 
    uint16_t latency;
 
    uint16_t supervision_timeout;
  };
 
  struct RequestedConnectionParameters {
    uint16_t min_interval;
 
    uint16_t max_interval;
 
    uint16_t max_latency;
 
    uint16_t supervision_timeout;
  };
 
  struct ConnectionOptions {
    bool bondable_mode = true;
 
    std::optional<Uuid> service_filter;
 
    std::optional<RequestedConnectionParameters> parameters;
 
    std::optional<uint16_t> att_mtu;
  };
 
  struct ConnectL2capParameters {
    Psm psm;
    uint16_t max_receive_packet_size;
    SecurityRequirements security_requirements;
  };
 
  virtual ~Connection2() = default;
 
  virtual async2::Poll<DisconnectReason> PendDisconnect(
      async2::Context& cx) = 0;
 
  virtual gatt::Client2* GattClient() = 0;
 
  virtual uint16_t AttMtu() = 0;
 
  virtual async2::Poll<uint16_t> PendAttMtuChange(async2::Context& cx) = 0;
 
  virtual ConnectionParameters Parameters() = 0;
 
  virtual async2::OnceReceiver<
      pw::expected<void, ConnectionParameterUpdateError>>
  RequestParameterUpdate(RequestedConnectionParameters parameters) = 0;
 
  virtual async2::OnceReceiver<pw::Result<Channel::Ptr>> ConnectL2cap(
      ConnectL2capParameters parameters) = 0;
 
 private:
  virtual void Release() = 0;
 
 public:
  using Ptr = internal::RaiiPtr<Connection2, &Connection2::Release>;
};
 
}  // namespace pw::bluetooth::low_energy