peripheral2.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 <cstdint>
#include <memory>
 
#include "pw_async2/dispatcher.h"
#include "pw_async2/once_sender.h"
#include "pw_bluetooth/internal/raii_ptr.h"
#include "pw_bluetooth/low_energy/advertising_data.h"
#include "pw_bluetooth/low_energy/connection2.h"
#include "pw_bluetooth/low_energy/phy.h"
#include "pw_bluetooth/types.h"
#include "pw_function/function.h"
#include "pw_result/expected.h"
 
namespace pw::bluetooth::low_energy {
 
class AdvertisedPeripheral2 {
 public:
  virtual ~AdvertisedPeripheral2() = default;
 
  virtual async2::Poll<Connection2::Ptr> PendConnection(
      async2::Context& cx) = 0;
 
  virtual void StopAdvertising() = 0;
 
  virtual async2::Poll<pw::Status> PendStop(async2::Context& cx) = 0;
 
 private:
  virtual void Release() = 0;
 
 public:
  using Ptr =
      internal::RaiiPtr<AdvertisedPeripheral2, &AdvertisedPeripheral2::Release>;
};
 
class Peripheral2 {
 public:
  struct AdvertisingIntervalRange {
    uint16_t min = 0x0800;
    uint16_t max = 0x0800;
  };
 
  using ScanResponse = AdvertisingData;
 
  using ConnectionOptions = Connection2::ConnectionOptions;
 
  struct LegacyAdvertising {
    std::optional<ScanResponse> scan_response;
 
    std::optional<ConnectionOptions> connection_options;
  };
 
  struct ExtendedAdvertising {
    struct Anonymous {};
 
    std::variant<std::monostate, ScanResponse, ConnectionOptions, Anonymous>
        configuration;
 
    std::optional<int8_t> tx_power;
 
    Phy primary_phy = Phy::k1Megabit;
 
    Phy secondary_phy = Phy::k1Megabit;
  };
 
  using AdvertisingProcedure =
      std::variant<LegacyAdvertising, ExtendedAdvertising>;
 
  struct AdvertisingParameters {
    AdvertisingData data;
 
    AdvertisingIntervalRange interval_range;
 
    std::optional<Address::Type> address_type;
 
    AdvertisingProcedure procedure;
  };
 
  enum class AdvertiseError {
    kNotSupported = 1,
 
    kAdvertisingDataTooLong = 2,
 
    kScanResponseDataTooLong = 3,
 
    kInvalidParameters = 4,
 
    kNotEnoughAdvertisingSlots = 5,
 
    kFailed = 6,
  };
 
  using AdvertiseResult =
      pw::expected<AdvertisedPeripheral2::Ptr, AdvertiseError>;
 
  virtual ~Peripheral2() = default;
 
  virtual async2::OnceReceiver<AdvertiseResult> Advertise(
      const AdvertisingParameters& parameters) = 0;
};
 
}  // namespace pw::bluetooth::low_energy