webrtc_m130/api/rtc_event_log_output.h
Boris Tsirkin 932e361a94 Format /api folder
At Meta, we have formatted the repo according to WebRTC .clang-format
file. Currently, those changes are stored as patch and we'd like to
apply them to the base WebRTC release instead.

I will be submitting CLs per folder. The plan is to format all h|cc|mm|m
files, while exlcuding Matlab files from the formatter as clang
misinterprets them as ObjC.

Formatting done via:

git ls-files | grep -E '^api\/.*\.(h|cc)' | xargs clang-format -i

No-Iwyu: Includes didn't change and it isn't related to formatting
Bug: webrtc:42225392
Change-Id: I4d7470104983d5d32612f9347301354265fb34c8
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/373520
Commit-Queue: Harald Alvestrand <hta@webrtc.org>
Reviewed-by: Danil Chapovalov <danilchap@webrtc.org>
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Cr-Commit-Position: refs/heads/main@{#43671}
2025-01-07 18:41:45 -08:00

43 lines
1.5 KiB
C++

/*
* Copyright (c) 2017 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#ifndef API_RTC_EVENT_LOG_OUTPUT_H_
#define API_RTC_EVENT_LOG_OUTPUT_H_
#include "absl/strings/string_view.h"
namespace webrtc {
// NOTE: This class is still under development and may change without notice.
class RtcEventLogOutput {
public:
virtual ~RtcEventLogOutput() = default;
// An output normally starts out active, though that might not always be
// the case (e.g. failed to open a file for writing).
// Once an output has become inactive (e.g. maximum file size reached), it can
// never become active again.
virtual bool IsActive() const = 0;
// Write encoded events to an output. Returns true if the output was
// successfully written in its entirety. Otherwise, no guarantee is given
// about how much data was written, if any. The output sink becomes inactive
// after the first time `false` is returned. Write() may not be called on
// an inactive output sink.
virtual bool Write(absl::string_view output) = 0;
// Indicates that buffers should be written to disk if applicable.
virtual void Flush() {}
};
} // namespace webrtc
#endif // API_RTC_EVENT_LOG_OUTPUT_H_