blob: 308b882dfc87b9fb061e79f71bad1e01dcca3cc1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef PLATFORM_IMPL_TLS_WRITE_BUFFER_H_
#define PLATFORM_IMPL_TLS_WRITE_BUFFER_H_
#include <atomic>
#include <memory>
#include "absl/types/span.h"
#include "platform/base/macros.h"
namespace openscreen {
namespace platform {
// This class is responsible for buffering TLS Write data. The approach taken by
// this class is to allow for a single thread to act as a publisher of data and
// for a separate thread to act as the consumer of that data. The data in
// question is written to a lockless FIFO queue. Whenever the capacity of the
// underlying array changes, Observer::NotifyWriteBufferFill() will be called.
class TlsWriteBuffer {
public:
class Observer {
public:
virtual ~Observer() = default;
// Signals that the write buffer has reached some percentage of being
// filled. NOTE: This method may be called from multiple threads.
virtual void NotifyWriteBufferFill(double fraction) = 0;
};
explicit TlsWriteBuffer(Observer* observer);
~TlsWriteBuffer();
// Writes as much of the provided data as possible in the buffer, returning
// the number of bytes written.
size_t Write(const void* data, size_t len);
// Returns a subset of the readable region of data. At time of reading, more
// data may be available for reading than what is represented in this Span.
absl::Span<const uint8_t> GetReadableRegion();
// Marks the provided number of bytes as consumed by the consumer thread.
void Consume(size_t byte_count);
// The amount of space to allocate in the buffer.
static constexpr size_t kBufferSizeBytes = 1 << 20; // 1 MB space.
private:
// Signals that the write buffer has reached some percentage of being filled,
// as calculated based on the provided write and read indices.
void NotifyWriteBufferFill(size_t write_index, size_t read_index);
// Buffer where data to be written over the TLS connection is stored.
uint8_t buffer_[kBufferSizeBytes];
// Total number of bytes read or written so far. Atomics are used both to
// ensure that read and write operations are atomic for uint64s on all systems
// and to ensure that different values for these values aren't loaded from
// each CPU's physical cache.
std::atomic_size_t bytes_read_so_far_{0};
std::atomic_size_t bytes_written_so_far_{0};
Observer* const observer_;
OSP_DISALLOW_COPY_AND_ASSIGN(TlsWriteBuffer);
};
} // namespace platform
} // namespace openscreen
#endif // PLATFORM_IMPL_TLS_WRITE_BUFFER_H_
|