client2.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_async2/value_future.h"
#include "pw_bluetooth/gatt/constants.h"
#include "pw_bluetooth/gatt/error.h"
#include "pw_bluetooth/gatt/types.h"
#include "pw_bluetooth/internal/raii_ptr.h"
#include "pw_containers/vector.h"
#include "pw_function/function.h"
#include "pw_multibuf/multibuf.h"
#include "pw_result/expected.h"
 
namespace pw::bluetooth::gatt {
 
 
class RemoteService2 {
 public:
  enum class RemoteServiceError {
    kServiceRemoved = 0,
 
    kPeerDisconnected = 1,
  };
 
  struct ReadValue {
    Handle handle;
 
    multibuf::MultiBuf value;
 
    bool maybe_truncated;
  };
 
  struct ReadByTypeResult {
    Handle handle;
 
    pw::expected<ReadValue, Error> result;
  };
 
  struct LongReadOptions {
    uint16_t offset = 0;
 
    uint16_t max_bytes = kMaxValueLength;
  };
 
  enum class WriteMode : uint8_t {
    kDefault,
 
    kReliable,
 
    kWithoutResponse,
  };
 
  struct WriteOptions {
    WriteMode mode = WriteMode::kDefault;
 
    uint16_t offset = 0;
  };
 
  virtual ~RemoteService2() = default;
 
  virtual async2::Poll<RemoteServiceError> PendError(async2::Context& cx) = 0;
 
  virtual async2::ValueFuture<Vector<Characteristic2>>
  DiscoverCharacteristics() = 0;
 
  virtual async2::ValueFuture<
      std::optional<pw::expected<Vector<ReadByTypeResult, 5>, Error>>>
  ReadByType(Uuid uuid) = 0;
 
  virtual async2::OptionalValueFuture<pw::expected<ReadValue, Error>>
  ReadCharacteristic(Handle handle, std::optional<LongReadOptions> options) = 0;
 
  virtual async2::OptionalValueFuture<pw::expected<void, Error>>
  WriteCharacteristic(Handle handle,
                      pw::multibuf::MultiBuf&& value,
                      WriteOptions options) = 0;
 
  virtual async2::OptionalValueFuture<pw::expected<ReadValue, Error>>
  ReadDescriptor(Handle handle, std::optional<LongReadOptions> options) = 0;
 
  virtual async2::OptionalValueFuture<pw::expected<void, Error>>
  WriteDescriptor(Handle handle, pw::multibuf::MultiBuf&& value) = 0;
 
  virtual async2::OptionalValueFuture<pw::expected<void, Error>>
  EnableNotifications(Handle handle) = 0;
 
  virtual async2::Poll<ReadValue> PendNotification(Handle handle,
                                                   async2::Context& cx) = 0;
 
  virtual async2::OptionalValueFuture<pw::expected<void, Error>>
  StopNotifications(Handle handle) = 0;
 
 private:
  virtual void Disconnect() = 0;
 
 public:
  using Ptr = internal::RaiiPtr<RemoteService2, &RemoteService2::Disconnect>;
};
 
class Client2 {
 public:
  struct RemoteServiceInfo {
    ServiceHandle handle;
 
    bool primary;
 
    Uuid type;
  };
 
  virtual ~Client2() = default;
 
  virtual async2::Poll<RemoteServiceInfo> PendServiceUpdate(
      async2::Context& cx);
 
  virtual async2::Poll<ServiceHandle> PendServiceRemoved(async2::Context& cx);
 
  virtual pw::expected<RemoteService2::Ptr, Error> ConnectToService(
      ServiceHandle handle) = 0;
};
 
}  // namespace pw::bluetooth::gatt