net/base/elements_upload_data_stream.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_BASE_ELEMENTS_UPLOAD_DATA_STREAM_H_
   6 #define NET_BASE_ELEMENTS_UPLOAD_DATA_STREAM_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/macros.h"
  10 #include "base/memory/ref_counted.h"
  11 #include "base/memory/scoped_ptr.h"
  12 #include "base/memory/scoped_vector.h"
  13 #include "base/memory/weak_ptr.h"
  14 #include "net/base/net_export.h"
  15 #include "net/base/upload_data_stream.h"
  16
  17 namespace net {
  18
  19 class DrainableIOBuffer;
  20 class IOBuffer;
  21 class UploadElementReader;
  22
  23 // A non-chunked UploadDataStream consisting of one or more UploadElements.
  24 class NET_EXPORT ElementsUploadDataStream : public UploadDataStream {
  25  public:
  26   ElementsUploadDataStream(ScopedVector<UploadElementReader> element_readers,
  27                            int64_t identifier);
  28
  29   ~ElementsUploadDataStream() override;
  30
  31   // Creates an ElementsUploadDataStream with a single reader.  Returns a
  32   // scoped_ptr<UploadDataStream> for ease of use.
  33   static scoped_ptr<UploadDataStream> CreateWithReader(
  34       scoped_ptr<UploadElementReader> reader,
  35       int64_t identifier);
  36
  37  private:
  38   // UploadDataStream implementation.
  39   bool IsInMemory() const override;
  40   const ScopedVector<UploadElementReader>* GetElementReaders() const override;
  41   int InitInternal() override;
  42   int ReadInternal(IOBuffer* buf, int buf_len) override;
  43   void ResetInternal() override;
  44
  45   // Runs Init() for all element readers.
  46   // This method is used to implement InitInternal().
  47   int InitElements(size_t start_index);
  48
  49   // Called when the |index| element finishes initialization. If it succeeded,
  50   // continues with the |index + 1| element. Calls OnInitCompleted on error or
  51   // when all elements have been initialized.
  52   void OnInitElementCompleted(size_t index, int result);
  53
  54   // Reads data from the element readers.
  55   // This method is used to implement Read().
  56   int ReadElements(const scoped_refptr<DrainableIOBuffer>& buf);
  57
  58   // Resumes pending read and calls OnReadCompleted with a result when
  59   // necessary.
  60   void OnReadElementCompleted(const scoped_refptr<DrainableIOBuffer>& buf,
  61                               int result);
  62
  63   // Processes result of UploadElementReader::Read(). If |result| indicates
  64   // success, updates |buf|'s offset. Otherwise, sets |read_failed_| to true.
  65   void ProcessReadResult(const scoped_refptr<DrainableIOBuffer>& buf,
  66                          int result);
  67
  68   ScopedVector<UploadElementReader> element_readers_;
  69
  70   // Index of the current upload element (i.e. the element currently being
  71   // read). The index is used as a cursor to iterate over elements in
  72   // |upload_data_|.
  73   size_t element_index_;
  74
  75   // True if an error occcured during read operation.
  76   bool read_failed_;
  77
  78   base::WeakPtrFactory<ElementsUploadDataStream> weak_ptr_factory_;
  79
  80   DISALLOW_COPY_AND_ASSIGN(ElementsUploadDataStream);
  81 };
  82
  83 }  // namespace net
  84
  85 #endif  // NET_BASE_ELEMENTS_UPLOAD_DATA_STREAM_H_