src/HttpStatusLine.h

   1 /*
   2  *
   3  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   4  * ----------------------------------------------------------
   5  *
   6  *  Squid is the result of efforts by numerous individuals from
   7  *  the Internet community; see the CONTRIBUTORS file for full
   8  *  details.   Many organizations have provided support for Squid's
   9  *  development; see the SPONSORS file for full details.  Squid is
  10  *  Copyrighted (C) 2001 by the Regents of the University of
  11  *  California; see the COPYRIGHT file for full details.  Squid
  12  *  incorporates software developed and/or copyrighted by other
  13  *  sources; see the CREDITS file for full details.
  14  *
  15  *  This program is free software; you can redistribute it and/or modify
  16  *  it under the terms of the GNU General Public License as published by
  17  *  the Free Software Foundation; either version 2 of the License, or
  18  *  (at your option) any later version.
  19  *
  20  *  This program is distributed in the hope that it will be useful,
  21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  *  GNU General Public License for more details.
  24  *
  25  *  You should have received a copy of the GNU General Public License
  26  *  along with this program; if not, write to the Free Software
  27  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  28  *
  29  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  30  */
  31 #ifndef SQUID_HTTPSTATUSLINE_H
  32 #define SQUID_HTTPSTATUSLINE_H
  33
  34 #include "http/ProtocolVersion.h"
  35 #include "http/StatusCode.h"
  36 #include "SquidString.h"
  37
  38 class Packer;
  39 class String;
  40
  41 /**
  42  * Holds the values parsed from an HTTP reply status line.
  43  *
  44  * For example: HTTP/1.1 200 Okay
  45  */
  46 class HttpStatusLine
  47 {
  48 public:
  49     /* public, read only */
  50
  51     /**
  52      * By rights protocol name should be a constant "HTTP", with no need for this field to exist.
  53      * However there are protocols which violate HTTP by sending their own custom formats
  54      * back with other protocol names (ICY streaming format being the current major problem).
  55      */
  56     AnyP::ProtocolType protocol;
  57
  58     Http::ProtocolVersion version;     ///< breakdown of protocol version labels: 0.9 1.0 1.1
  59     Http::StatusCode status; ///< status code. ie 200 404
  60     const char *reason;      ///< points to a _constant_ string (default or supplied), never free()d */
  61 };
  62
  63 /* init/clean */
  64 void httpStatusLineInit(HttpStatusLine * sline);
  65 void httpStatusLineClean(HttpStatusLine * sline);
  66 /* set/get values */
  67 void httpStatusLineSet(HttpStatusLine * sline, Http::ProtocolVersion version,
  68                        Http::StatusCode status, const char *reason);
  69 const char *httpStatusLineReason(const HttpStatusLine * sline);
  70 /* parse/pack */
  71 /* parse a 0-terminating buffer and fill internal structires; returns true on success */
  72 int httpStatusLineParse(HttpStatusLine * sline, const String &protoPrefix,
  73                         const char *start, const char *end);
  74 /* pack fields using Packer */
  75 void httpStatusLinePackInto(const HttpStatusLine * sline, Packer * p);
  76
  77 const char *httpStatusString(Http::StatusCode status);
  78
  79 #endif /* SQUID_HTTPSTATUSLINE_H */