Files
2025-09-10 11:14:14 -07:00

139 lines
4.8 KiB
Objective-C

// Copyright 2023 Google LLC
//
// 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.
// Note: File language is detected using heuristics. Many Objective-C++ headers are incorrectly
// classified as C++ resulting in invalid linter errors. The use of "NSArray" and other Foundation
// classes like "NSData", "NSDictionary" and "NSUUID" are highly weighted for Objective-C and
// Objective-C++ scores. Oddly, "#import <Foundation/Foundation.h>" does not contribute any points.
// This comment alone should be enough to trick the IDE in to believing this is actually some sort
// of Objective-C file. See: cs/google3/devtools/search/lang/recognize_language_classifiers_data
// TODO(b/293336684): Remove this file when shared Weave is complete.
#import <Foundation/Foundation.h>
#include <memory>
#include "internal/platform/implementation/ble_v2.h"
#import "internal/platform/implementation/apple/ble_peripheral.h"
@class GNCMConnectionHandlers;
@protocol GNCMConnection;
namespace nearby {
namespace apple {
// A readable stream of bytes.
class BleInputStream : public InputStream {
public:
BleInputStream();
~BleInputStream() override;
// Reads at most `size` bytes from the input stream.
//
// Returns an empty byte array on end of file, or Exception::kIo on error.
ExceptionOr<ByteArray> Read(std::int64_t size) override;
// Closes the stream preventing further reads.
//
// Returns Exception::kIo on error, otherwise Exception::kSuccess.
Exception Close() override;
GNCMConnectionHandlers *GetConnectionHandlers() { return connectionHandlers_; }
private:
GNCMConnectionHandlers *connectionHandlers_;
NSMutableArray<NSData *> *newDataPackets_;
NSMutableData *accumulatedData_;
NSCondition *condition_;
};
// A writable stream of bytes.
class BleOutputStream : public OutputStream {
public:
explicit BleOutputStream(id<GNCMConnection> connection)
: connection_(connection), condition_([[NSCondition alloc] init]) {}
~BleOutputStream() override;
// Write the provided bytes to the output stream.
//
// Returns Exception::kIo on error, otherwise Exception::kSuccess.
Exception Write(const ByteArray &data) override;
// no-op
//
// Always returns Exception::kSuccess.
Exception Flush() override;
// Closes the stream preventing further writes.
//
// Returns Exception::kIo on error, otherwise Exception::kSuccess.
Exception Close() override;
private:
id<GNCMConnection> connection_;
NSCondition *condition_;
};
// A BLE Weave socket.
class BleSocket : public api::ble_v2::BleSocket {
public:
explicit BleSocket(id<GNCMConnection> connection);
// The peripheral used to create the socket must outlive the socket or undefined behavior will
// occur.
BleSocket(id<GNCMConnection> connection, api::ble_v2::BlePeripheral::UniqueId peripheral_id);
~BleSocket() override;
// Returns the InputStream of the BleSocket.
// On error, returned stream will report Exception::kIo on any operation.
//
// The returned object is not owned by the caller, and can be invalidated once
// the BleSocket object is destroyed.
BleInputStream &GetInputStream() override { return *input_stream_; }
// Returns the OutputStream of the BleSocket.
// On error, returned stream will report Exception::kIo on any operation.
//
// The returned object is not owned by the caller, and can be invalidated once
// the BleSocket object is destroyed.
BleOutputStream &GetOutputStream() override { return *output_stream_; }
// Returns Exception::kIo on error, otherwise Exception::kSuccess.
Exception Close() override ABSL_LOCKS_EXCLUDED(mutex_);
// Returns valid BlePeripheral pointer if there is a connection, and
// nullptr otherwise.
api::ble_v2::BlePeripheral::UniqueId GetRemotePeripheralId() override { return peripheral_id_; }
bool IsClosed() const ABSL_LOCKS_EXCLUDED(mutex_);
// Sets a notifier that will be called when the socket is closed.
void SetCloseNotifier(absl::AnyInvocable<void()> notifier) ABSL_LOCKS_EXCLUDED(mutex_);
private:
void DoClose() ABSL_EXCLUSIVE_LOCKS_REQUIRED(mutex_);
mutable absl::Mutex mutex_;
bool closed_ ABSL_GUARDED_BY(mutex_) = false;
std::unique_ptr<BleInputStream> input_stream_;
std::unique_ptr<BleOutputStream> output_stream_;
api::ble_v2::BlePeripheral::UniqueId peripheral_id_;
absl::AnyInvocable<void()> close_notifier_;
};
} // namespace apple
} // namespace nearby