netwerk/protocol/http/src/nsHttpRequestHead.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 nsHttpRequestHead_h__
  40 #define nsHttpRequestHead_h__
  41
  42 #include "nsHttpHeaderArray.h"
  43 #include "nsHttp.h"
  44 #include "nsString.h"
  45 #include "nsCRT.h"
  46
  47 //-----------------------------------------------------------------------------
  48 // nsHttpRequestHead represents the request line and headers from an HTTP
  49 // request.
  50 //-----------------------------------------------------------------------------
  51
  52 class nsHttpRequestHead
  53 {
  54 public:
  55     nsHttpRequestHead() : mMethod(nsHttp::Get), mVersion(NS_HTTP_VERSION_1_1) {}
  56    ~nsHttpRequestHead() {}
  57
  58     void SetMethod(nsHttpAtom method) { mMethod = method; }
  59     void SetVersion(nsHttpVersion version) { mVersion = version; }
  60     void SetRequestURI(const nsCSubstring &s) { mRequestURI = s; }
  61
  62     nsHttpHeaderArray  &Headers()    { return mHeaders; }
  63     nsHttpAtom          Method()     { return mMethod; }
  64     nsHttpVersion       Version()    { return mVersion; }
  65     const nsCSubstring &RequestURI() { return mRequestURI; }
  66
  67     const char *PeekHeader(nsHttpAtom h)                                     { return mHeaders.PeekHeader(h); }
  68     nsresult SetHeader(nsHttpAtom h, const nsACString &v, PRBool m=PR_FALSE) { return mHeaders.SetHeader(h, v, m); }
  69     nsresult GetHeader(nsHttpAtom h, nsACString &v)                          { return mHeaders.GetHeader(h, v); }
  70     void ClearHeader(nsHttpAtom h)                                           { mHeaders.ClearHeader(h); }
  71     void ClearHeaders()                                                      { mHeaders.Clear(); }
  72
  73     const char *FindHeaderValue(nsHttpAtom h, const char *v) { return mHeaders.FindHeaderValue(h, v); }
  74     PRBool      HasHeaderValue(nsHttpAtom h, const char *v) { return mHeaders.HasHeaderValue(h, v); }
  75
  76     void Flatten(nsACString &, PRBool pruneProxyHeaders = PR_FALSE);
  77
  78 private:
  79     nsHttpHeaderArray mHeaders;
  80     nsHttpAtom        mMethod;
  81     nsHttpVersion     mVersion;
  82     nsCString         mRequestURI;
  83 };
  84
  85 #endif // nsHttpRequestHead_h__