Land Recent QUIC Changes

net/quic/quic_packet_creator.h

 // Copyright (c) 2012 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.
 //
 // Accumulates frames for the next packet until more frames no longer fit or
 // it's time to create a packet from them.  Also provides packet creation of
 // FEC packets based on previously created packets.
 
 #ifndef NET_QUIC_QUIC_PACKET_CREATOR_H_
 #define NET_QUIC_QUIC_PACKET_CREATOR_H_
 
 #include <utility>
 #include <vector>
 
 #include "base/memory/scoped_ptr.h"
 #include "base/string_piece.h"
 #include "net/quic/quic_fec_group.h"
 #include "net/quic/quic_framer.h"
 #include "net/quic/quic_protocol.h"
 
 namespace net {
+namespace test {
+class QuicPacketCreatorPeer;
+}
 
 class QuicRandom;
 
 class NET_EXPORT_PRIVATE QuicPacketCreator : public QuicFecBuilderInterface {
  public:
   // Options for controlling how packets are created.
   struct Options {
     Options()
         : max_packet_length(kMaxPacketSize),
           random_reorder(false),
           max_packets_per_fec_group(0) {
     }
 
     size_t max_packet_length;
     bool random_reorder;   // Inefficient: rewrite if used at scale.
     // 0 indicates fec is disabled.
     size_t max_packets_per_fec_group;
   };
 
   // QuicRandom* required for packet entropy.
   QuicPacketCreator(QuicGuid guid,
                     QuicFramer* framer,
-                    QuicRandom* random_generator);
+                    QuicRandom* random_generator,
+                    bool is_server);
 
   virtual ~QuicPacketCreator();
 
   // QuicFecBuilderInterface
   virtual void OnBuiltFecProtectedPayload(const QuicPacketHeader& header,
                                           base::StringPiece payload) OVERRIDE;
 
   // Checks if it's time to send an FEC packet.  |force_close| forces this to
   // return true if an fec group is open.
   bool ShouldSendFec(bool force_close) const;
 
   // Starts a new FEC group with the next serialized packet, if FEC is enabled
   // and there is not already an FEC group open.
   void MaybeStartFEC();
 
+  // Makes the framer not serialize the protocol version in sent packets.
+  void StopSendingVersion();
+
   // The overhead the framing will add for a packet with num_frames frames.
   static size_t StreamFramePacketOverhead(int num_frames, bool include_version);
 
   bool HasRoomForStreamFrame() const;
 
   // Converts a raw payload to a frame which fits into the currently open
   // packet if there is one.  Returns the number of bytes consumed from data.
   // If data is empty and fin is true, the expected behavior is to consume the
   // fin but return 0.
   size_t CreateStreamFrame(QuicStreamId id,
@@ skipping 31 matching lines @@
   // the entropy hash of the serialized packet to a random bool and returns
   // that value as a member of SerializedPacket.
   SerializedPacket SerializeFec();
 
   // Creates a packet with connection close frame. Caller owns the created
   // packet. Also, sets the entropy hash of the serialized packet to a random
   // bool and returns that value as a member of SerializedPacket.
   SerializedPacket SerializeConnectionClose(
       QuicConnectionCloseFrame* close_frame);
 
+  // Creates a version negotiation packet which supports |supported_versions|.
+  // Caller owns the created  packet. Also, sets the entropy hash of the
+  // serialized packet to a random bool and returns that value as a member of
+  // SerializedPacket.
+  QuicEncryptedPacket* SerializeVersionNegotiationPacket(
+      const QuicVersionTagList& supported_versions);
+
   QuicPacketSequenceNumber sequence_number() const {
     return sequence_number_;
   }
 
   void set_sequence_number(QuicPacketSequenceNumber s) {
     sequence_number_ = s;
   }
 
   Options* options() {
     return &options_;
   }
 
  private:
+  friend class test::QuicPacketCreatorPeer;
+
   static bool ShouldRetransmit(const QuicFrame& frame);
 
   void FillPacketHeader(QuicFecGroupNumber fec_group,
                         bool fec_flag,
                         bool fec_entropy_flag,
                         QuicPacketHeader* header);
 
   // Allows a frame to be added without creating retransmittable frames.
   // Particularly useful for retransmits using SerializeAllFrames().
   bool AddFrame(const QuicFrame& frame, bool save_retransmittable_frames);
 
   Options options_;
   QuicGuid guid_;
   QuicFramer* framer_;
   QuicRandom* random_generator_;
   QuicPacketSequenceNumber sequence_number_;
   QuicFecGroupNumber fec_group_number_;
   scoped_ptr<QuicFecGroup> fec_group_;
+  // bool to keep track if this packet creator is being used the server.
+  bool is_server_;
+  // Controls whether protocol version should be included while serializing the
+  // packet.
+  bool send_version_in_packet_;
   size_t packet_size_;
   QuicFrames queued_frames_;
   scoped_ptr<RetransmittableFrames> queued_retransmittable_frames_;
 
   DISALLOW_COPY_AND_ASSIGN(QuicPacketCreator);
 };
 
 }  // namespace net
 
 #endif  // NET_QUIC_QUIC_PACKET_CREATOR_H_