HPACK changes required for specification draft '08

net/spdy/hpack_header_table.h

 // Copyright 2014 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.
 
 #ifndef NET_SPDY_HPACK_HEADER_TABLE_H_
 #define NET_SPDY_HPACK_HEADER_TABLE_H_
 
 #include <cstddef>
 #include <deque>
 #include <set>
 
 #include "base/basictypes.h"
 #include "base/macros.h"
 #include "net/base/net_export.h"
 #include "net/spdy/hpack_entry.h"
 
 // All section references below are to
-// http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-07
+// http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-08
 
 namespace net {
 
 namespace test {
 class HpackHeaderTablePeer;
 }  // namespace test
 
-// A data structure for both the header table (described in 3.1.2) and
-// the reference set (3.1.3).
+// A data structure for both the header table (described in 3.2) and
+// the reference set (3.3).
 class NET_EXPORT_PRIVATE HpackHeaderTable {
  public:
   friend class test::HpackHeaderTablePeer;
 
   // HpackHeaderTable takes advantage of the deque property that references
   // remain valid, so long as insertions & deletions are at the head & tail.
   // If this changes (eg we start to drop entries from the middle of the table),
   // this needs to be a std::list, in which case |index_| can be trivially
   // extended to map to list iterators.
   typedef std::deque<HpackEntry> EntryTable;
@@ skipping 14 matching lines @@
   typedef std::set<HpackEntry*, EntryComparator> OrderedEntrySet;
 
   HpackHeaderTable();
 
   ~HpackHeaderTable();
 
   // Last-aknowledged value of SETTINGS_HEADER_TABLE_SIZE.
   size_t settings_size_bound() { return settings_size_bound_; }
 
   // Current and maximum estimated byte size of the table, as described in
-  // 3.3.1. Notably, this is /not/ the number of entries in the table.
+  // 5.1. Notably, this is /not/ the number of entries in the table.
   size_t size() const { return size_; }
   size_t max_size() const { return max_size_; }
 
   const OrderedEntrySet& reference_set() {
     return reference_set_;
   }
 
   // Returns the entry matching the index, or NULL.
   HpackEntry* GetByIndex(size_t index);
 
   // Returns the lowest-value entry having |name|, or NULL.
   HpackEntry* GetByName(base::StringPiece name);
 
   // Returns the lowest-index matching entry, or NULL.
   HpackEntry* GetByNameAndValue(base::StringPiece name,
                                 base::StringPiece value);
 
   // Returns the index of an entry within this header table.
   size_t IndexOf(const HpackEntry* entry) const;
 
   // Sets the maximum size of the header table, evicting entries if
-  // necessary as described in 3.3.2.
+  // necessary as described in 5.2.
   void SetMaxSize(size_t max_size);
 
   // Sets the SETTINGS_HEADER_TABLE_SIZE bound of the table. Will call
   // SetMaxSize() as needed to preserve max_size() <= settings_size_bound().
   void SetSettingsHeaderTableSize(size_t settings_size);
 
   // Determine the set of entries which would be evicted by the insertion
   // of |name| & |value| into the table, as per section 3.3.3. No eviction
   // actually occurs. The set is returned via range [begin_out, end_out).
   void EvictionSet(base::StringPiece name, base::StringPiece value,
@@ skipping 47 matching lines @@
   // Total number of table insertions which have occurred. Referenced by
   // IndexOf() for determination of an HpackEntry's table index.
   size_t total_insertions_;
 
   DISALLOW_COPY_AND_ASSIGN(HpackHeaderTable);
 };
 
 }  // namespace net
 
 #endif  // NET_SPDY_HPACK_HEADER_TABLE_H_