netwerk/protocol/http/src/nsHttpChunkedDecoder.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications.
  19  * Portions created by the Initial Developer are Copyright (C) 2001
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Darin Fisher <darin@netscape.com> (original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsHttpChunkedDecoder_h__
  40 #define nsHttpChunkedDecoder_h__
  41
  42 #include "nsError.h"
  43 #include "nsString.h"
  44 #include "nsHttpHeaderArray.h"
  45
  46 class nsHttpChunkedDecoder
  47 {
  48 public:
  49     nsHttpChunkedDecoder() : mTrailers(nsnull)
  50                            , mChunkRemaining(0)
  51                            , mReachedEOF(PR_FALSE)
  52                            , mWaitEOF(PR_FALSE) {}
  53    ~nsHttpChunkedDecoder() { delete mTrailers; }
  54
  55     PRBool ReachedEOF() { return mReachedEOF; }
  56
  57     // called by the transaction to handle chunked content.
  58     nsresult HandleChunkedContent(char *buf,
  59                                   PRUint32 count,
  60                                   PRUint32 *contentRead,
  61                                   PRUint32 *contentRemaining);
  62
  63     nsHttpHeaderArray *Trailers() { return mTrailers; }
  64
  65     nsHttpHeaderArray *TakeTrailers() { nsHttpHeaderArray *h = mTrailers;
  66                                         mTrailers = nsnull;
  67                                         return h; }
  68
  69 private:
  70     nsresult ParseChunkRemaining(char *buf,
  71                                  PRUint32 count,
  72                                  PRUint32 *countRead);
  73
  74 private:
  75     nsHttpHeaderArray *mTrailers;
  76     PRUint32           mChunkRemaining;
  77     nsCString          mLineBuf; // may hold a partial line
  78     PRPackedBool       mReachedEOF;
  79     PRPackedBool       mWaitEOF;
  80 };
  81
  82 #endif