summaryrefslogtreecommitdiffstats
path: root/third_party/libwebrtc/api/rtc_event_log_output.h
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/libwebrtc/api/rtc_event_log_output.h')
-rw-r--r--third_party/libwebrtc/api/rtc_event_log_output.h44
1 files changed, 44 insertions, 0 deletions
diff --git a/third_party/libwebrtc/api/rtc_event_log_output.h b/third_party/libwebrtc/api/rtc_event_log_output.h
new file mode 100644
index 0000000000..f1f84a5f3a
--- /dev/null
+++ b/third_party/libwebrtc/api/rtc_event_log_output.h
@@ -0,0 +1,44 @@
+/*
+ * 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(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_