blob: cb8fce60cb52db4efb322f7178acd5bff9b6a7b4 [file] [log] [blame]
/*
* Copyright (c) 2019 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 LOGGING_RTC_EVENT_LOG_EVENTS_RTC_EVENT_GENERIC_PACKET_SENT_H_
#define LOGGING_RTC_EVENT_LOG_EVENTS_RTC_EVENT_GENERIC_PACKET_SENT_H_
#include <cstddef>
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
#include "absl/strings/string_view.h"
#include "api/array_view.h"
#include "api/rtc_event_log/rtc_event.h"
#include "api/units/timestamp.h"
#include "logging/rtc_event_log/events/rtc_event_log_parse_status.h"
namespace webrtc {
struct LoggedGenericPacketSent {
LoggedGenericPacketSent() = default;
LoggedGenericPacketSent(Timestamp timestamp,
int64_t packet_number,
size_t overhead_length,
size_t payload_length,
size_t padding_length)
: timestamp(timestamp),
packet_number(packet_number),
overhead_length(overhead_length),
payload_length(payload_length),
padding_length(padding_length) {}
int64_t log_time_us() const { return timestamp.us(); }
int64_t log_time_ms() const { return timestamp.ms(); }
Timestamp log_time() const { return timestamp; }
size_t packet_length() const {
return payload_length + padding_length + overhead_length;
}
Timestamp timestamp = Timestamp::MinusInfinity();
int64_t packet_number;
size_t overhead_length;
size_t payload_length;
size_t padding_length;
};
class RtcEventGenericPacketSent final : public RtcEvent {
public:
static constexpr Type kType = Type::GenericPacketSent;
RtcEventGenericPacketSent(int64_t packet_number,
size_t overhead_length,
size_t payload_length,
size_t padding_length);
~RtcEventGenericPacketSent() override;
std::unique_ptr<RtcEventGenericPacketSent> Copy() const;
Type GetType() const override { return kType; }
bool IsConfigEvent() const override { return false; }
// An identifier of the packet.
int64_t packet_number() const { return packet_number_; }
// Total packet length, including all packetization overheads, but not
// including ICE/TURN/IP overheads.
size_t packet_length() const {
return overhead_length_ + payload_length_ + padding_length_;
}
// The number of bytes in overhead, including framing overheads, acks if
// present, etc.
size_t overhead_length() const { return overhead_length_; }
// Length of payload sent (size of raw audio/video/data), without
// packetization overheads. This may still include serialization overheads.
size_t payload_length() const { return payload_length_; }
size_t padding_length() const { return padding_length_; }
static std::string Encode(rtc::ArrayView<const RtcEvent*> batch) {
// TODO(terelius): Implement
return "";
}
static RtcEventLogParseStatus Parse(
absl::string_view encoded_bytes,
bool batched,
std::vector<LoggedGenericPacketSent>& output) {
// TODO(terelius): Implement
return RtcEventLogParseStatus::Error("Not Implemented", __FILE__, __LINE__);
}
private:
RtcEventGenericPacketSent(const RtcEventGenericPacketSent& packet);
const int64_t packet_number_;
const size_t overhead_length_;
const size_t payload_length_;
const size_t padding_length_;
};
} // namespace webrtc
#endif // LOGGING_RTC_EVENT_LOG_EVENTS_RTC_EVENT_GENERIC_PACKET_SENT_H_