Files
nearby/internal/platform/input_stream.h
T
Janusz Sobczak a7a3eb8a92 Use consistent return value in Pipe read.
Previously reading from an empty, closed Pipe returned:
* IO exception if there were no writes to the pipe,
* Empty byte array if there were writes to the pipe.
With this change, we return an empty byte array on both paths.

This also fixes a subtle race condition in the following flow:
1. Pipe is empty
2. Thread A is reading from the pipe (blocking call).
3. Thread B writes to the pipe and immediately closes it.
4. Thread A is unblocked and returns IO error. The data written by thread B is
   ignored!

The new test in bluetooth_classic_test triggered that defect consistently.

PiperOrigin-RevId: 518107700
2023-03-20 16:26:52 -07:00

48 lines
1.5 KiB
C++

// Copyright 2020 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.
#ifndef PLATFORM_BASE_INPUT_STREAM_H_
#define PLATFORM_BASE_INPUT_STREAM_H_
#include <cstdint>
#include "internal/platform/byte_array.h"
#include "internal/platform/exception.h"
namespace nearby {
// An InputStream represents an input stream of bytes.
//
// https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html
class InputStream {
public:
virtual ~InputStream() = default;
// Reads at most `size` bytes from the input stream.
// Returns an empty byte array on end of file, or Exception::kIo on error.
virtual ExceptionOr<ByteArray> Read(std::int64_t size) = 0;
// Skips `offset` bytes from the stream.
// Returns the number of bytes skipped, which can be less than offset on EOF,
// or Exception::kIo on error.
virtual ExceptionOr<size_t> Skip(size_t offset);
// throws Exception::kIo
virtual Exception Close() = 0;
};
} // namespace nearby
#endif // PLATFORM_BASE_INPUT_STREAM_H_