net/spdy/spdy_io_buffer.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef NET_SPDY_SPDY_IO_BUFFER_H_
   6 #define NET_SPDY_SPDY_IO_BUFFER_H_
   7
   8 #include "base/memory/ref_counted.h"
   9 #include "net/base/io_buffer.h"
  10 #include "net/base/net_export.h"
  11 #include "net/base/request_priority.h"
  12
  13 namespace net {
  14
  15 class SpdyStream;
  16
  17 // A class for managing SPDY IO buffers.  These buffers need to be prioritized
  18 // so that the SpdySession sends them in the right order.  Further, they need
  19 // to track the SpdyStream which they are associated with so that incremental
  20 // completion of the IO can notify the appropriate stream of completion.
  21 class NET_EXPORT_PRIVATE SpdyIOBuffer {
  22  public:
  23   // Constructor
  24   // |buffer| is the actual data buffer.
  25   // |size| is the size of the data buffer.
  26   // |priority| is the priority of this buffer.
  27   // |stream| is a pointer to the stream which is managing this buffer.
  28   SpdyIOBuffer(IOBuffer* buffer, int size, RequestPriority priority,
  29                SpdyStream* stream);
  30   // Declare this instead of using the default so that we avoid needing to
  31   // include spdy_stream.h.
  32   SpdyIOBuffer(const SpdyIOBuffer& rhs);
  33   SpdyIOBuffer();
  34   ~SpdyIOBuffer();
  35   // Declare this instead of using the default so that we avoid needing to
  36   // include spdy_stream.h.
  37   SpdyIOBuffer& operator=(const SpdyIOBuffer& rhs);
  38
  39   // Accessors.
  40   DrainableIOBuffer* buffer() const { return buffer_; }
  41   size_t size() const { return buffer_->size(); }
  42   void release();
  43   RequestPriority priority() const { return priority_; }
  44   const scoped_refptr<SpdyStream>& stream() const { return stream_; }
  45
  46   // Comparison operator to support sorting.
  47   bool operator<(const SpdyIOBuffer& other) const {
  48     if (priority_ != other.priority_)
  49       return priority_ < other.priority_;
  50     return position_ > other.position_;
  51   }
  52
  53  private:
  54   scoped_refptr<DrainableIOBuffer> buffer_;
  55   RequestPriority priority_;
  56   uint64 position_;
  57   scoped_refptr<SpdyStream> stream_;
  58   static uint64 order_;  // Maintains a FIFO order for equal priorities.
  59 };
  60
  61 }  // namespace net
  62
  63 #endif  // NET_SPDY_SPDY_IO_BUFFER_H_