webrtc/api/rtc_event_log_output.h
Sebastian Jansson 52de8b0270 Adds functionality to write logs to memory.
This makes it possible to save log outputs from scenario tests to
either files or memory.

Bug: webrtc:9510
Change-Id: I883bd8240ab712d31d54118adf979041bd83481a
Reviewed-on: https://webrtc-review.googlesource.com/c/116321
Commit-Queue: Sebastian Jansson <srte@webrtc.org>
Reviewed-by: Per Kjellander <perkj@webrtc.org>
Reviewed-by: Niels Moller <nisse@webrtc.org>
Reviewed-by: Björn Terelius <terelius@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#26284}
2019-01-16 17:36:31 +00:00

42 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 <string>
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;
// Indicates that buffers should be written to disk if applicable.
virtual void Flush() {}
};
} // namespace webrtc
#endif // API_RTC_EVENT_LOG_OUTPUT_H_