Back to index

lightning-sunbird  0.9+nobinonly
nsHttpRequestHead.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Darin Fisher <darin@netscape.com> (original author)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsHttpRequestHead_h__
00040 #define nsHttpRequestHead_h__
00041 
00042 #include "nsHttpHeaderArray.h"
00043 #include "nsHttp.h"
00044 #include "nsString.h"
00045 #include "nsCRT.h"
00046 
00047 //-----------------------------------------------------------------------------
00048 // nsHttpRequestHead represents the request line and headers from an HTTP
00049 // request.
00050 //-----------------------------------------------------------------------------
00051 
00052 class nsHttpRequestHead
00053 {
00054 public:
00055     nsHttpRequestHead() : mMethod(nsHttp::Get), mVersion(NS_HTTP_VERSION_1_1) {}
00056    ~nsHttpRequestHead() {}
00057 
00058     void SetMethod(nsHttpAtom method) { mMethod = method; }
00059     void SetVersion(nsHttpVersion version) { mVersion = version; }
00060     void SetRequestURI(const nsCSubstring &s) { mRequestURI = s; }
00061 
00062     nsHttpHeaderArray  &Headers()    { return mHeaders; }
00063     nsHttpAtom          Method()     { return mMethod; }
00064     nsHttpVersion       Version()    { return mVersion; }
00065     const nsCSubstring &RequestURI() { return mRequestURI; }
00066 
00067     const char *PeekHeader(nsHttpAtom h)                                     { return mHeaders.PeekHeader(h); }
00068     nsresult SetHeader(nsHttpAtom h, const nsACString &v, PRBool m=PR_FALSE) { return mHeaders.SetHeader(h, v, m); }
00069     nsresult GetHeader(nsHttpAtom h, nsACString &v)                          { return mHeaders.GetHeader(h, v); }
00070     void ClearHeader(nsHttpAtom h)                                           { mHeaders.ClearHeader(h); }
00071     void ClearHeaders()                                                      { mHeaders.Clear(); }
00072 
00073     void Flatten(nsACString &, PRBool pruneProxyHeaders = PR_FALSE);
00074 
00075 private:
00076     nsHttpHeaderArray mHeaders;
00077     nsHttpAtom        mMethod;
00078     nsHttpVersion     mVersion;
00079     nsCString         mRequestURI;
00080 };
00081 
00082 #endif // nsHttpRequestHead_h__