rtc_event_log_output.h (1531B)
1 /* 2 * Copyright (c) 2017 The WebRTC project authors. All Rights Reserved. 3 * 4 * Use of this source code is governed by a BSD-style license 5 * that can be found in the LICENSE file in the root of the source 6 * tree. An additional intellectual property rights grant can be found 7 * in the file PATENTS. All contributing project authors may 8 * be found in the AUTHORS file in the root of the source tree. 9 */ 10 11 #ifndef API_RTC_EVENT_LOG_OUTPUT_H_ 12 #define API_RTC_EVENT_LOG_OUTPUT_H_ 13 14 #include "absl/strings/string_view.h" 15 16 namespace webrtc { 17 18 // NOTE: This class is still under development and may change without notice. 19 class RtcEventLogOutput { 20 public: 21 virtual ~RtcEventLogOutput() = default; 22 23 // An output normally starts out active, though that might not always be 24 // the case (e.g. failed to open a file for writing). 25 // Once an output has become inactive (e.g. maximum file size reached), it can 26 // never become active again. 27 virtual bool IsActive() const = 0; 28 29 // Write encoded events to an output. Returns true if the output was 30 // successfully written in its entirety. Otherwise, no guarantee is given 31 // about how much data was written, if any. The output sink becomes inactive 32 // after the first time `false` is returned. Write() may not be called on 33 // an inactive output sink. 34 virtual bool Write(absl::string_view output) = 0; 35 36 // Indicates that buffers should be written to disk if applicable. 37 virtual void Flush() {} 38 }; 39 40 } // namespace webrtc 41 42 #endif // API_RTC_EVENT_LOG_OUTPUT_H_