blob: 2290dabe6d043b759408cd78613d8e567b496e8e [file] [log] [blame]
// Copyright (c) 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <ostream>
#include "quiche/quic/core/frames/quic_inlined_frame.h"
#include "quiche/quic/core/quic_constants.h"
#include "quiche/quic/core/quic_types.h"
namespace quic {
// The BLOCKED frame is used to indicate to the remote endpoint that this
// endpoint believes itself to be flow-control blocked but otherwise ready to
// send data. The BLOCKED frame is purely advisory and optional.
// Based on SPDY's BLOCKED frame (undocumented as of 2014-01-28).
struct QUICHE_EXPORT QuicBlockedFrame
: public QuicInlinedFrame<QuicBlockedFrame> {
QuicBlockedFrame(QuicControlFrameId control_frame_id, QuicStreamId stream_id,
QuicStreamOffset offset);
friend QUICHE_EXPORT std::ostream& operator<<(std::ostream& os,
const QuicBlockedFrame& b);
bool operator==(const QuicBlockedFrame& rhs) const;
bool operator!=(const QuicBlockedFrame& rhs) const;
QuicFrameType type;
// A unique identifier of this control frame. 0 when this frame is received,
// and non-zero when sent.
QuicControlFrameId control_frame_id = kInvalidControlFrameId;
// 0 is a special case meaning the connection is blocked, rather than a
// stream. So stream_id 0 corresponds to a BLOCKED frame and non-0
// corresponds to a STREAM_BLOCKED.
// TODO(fkastenholz): This should be converted to use
// QuicUtils::GetInvalidStreamId to get the correct invalid stream id value
// and not rely on 0.
QuicStreamId stream_id = 0;
// For Google QUIC, the offset is ignored.
QuicStreamOffset offset = 0;
} // namespace quic