mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-12 21:30:45 +01:00
63299a3124
Bug: webrtc:13579 Change-Id: I13f63fb6be6aa62c2e011c18327499fa16b5824e Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/267641 Commit-Queue: Björn Terelius <terelius@webrtc.org> Reviewed-by: Harald Alvestrand <hta@webrtc.org> Reviewed-by: Ali Tofigh <alito@webrtc.org> Cr-Commit-Position: refs/heads/main@{#37440}
49 lines
1.7 KiB
C++
49 lines
1.7 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 <string>
|
|
|
|
#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(const std::string& output) = 0;
|
|
// TODO(bugs.webrtc.org/13579): Make pure virtual and remove the string ref
|
|
// once all classes implement the string_view version.
|
|
virtual bool Write(absl::string_view output) {
|
|
return Write(std::string(output));
|
|
}
|
|
|
|
// Indicates that buffers should be written to disk if applicable.
|
|
virtual void Flush() {}
|
|
};
|
|
|
|
} // namespace webrtc
|
|
|
|
#endif // API_RTC_EVENT_LOG_OUTPUT_H_
|