src/htcp.h

   1 /*
   2  * $Id: htcp.h,v 1.7 2008/02/26 21:49:35 amosjeffries Exp $
   3  *
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   8  *  Squid is the result of efforts by numerous individuals from
   9  *  the Internet community; see the CONTRIBUTORS file for full
  10  *  details.   Many organizations have provided support for Squid's
  11  *  development; see the SPONSORS file for full details.  Squid is
  12  *  Copyrighted (C) 2001 by the Regents of the University of
  13  *  California; see the COPYRIGHT file for full details.  Squid
  14  *  incorporates software developed and/or copyrighted by other
  15  *  sources; see the CREDITS file for full details.
  16  *
  17  *  This program is free software; you can redistribute it and/or modify
  18  *  it under the terms of the GNU General Public License as published by
  19  *  the Free Software Foundation; either version 2 of the License, or
  20  *  (at your option) any later version.
  21  *
  22  *  This program is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License
  28  *  along with this program; if not, write to the Free Software
  29  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  30  *
  31  */
  32
  33 #ifndef SQUID_HTCP_H
  34 #define SQUID_HTCP_H
  35
  36 #if USE_HTCP
  37 #include "HttpHeader.h"
  38 #include "IPAddress.h"
  39
  40 /// \ingroup ServerProtocolHTCP
  41 class HtcpReplyData
  42 {
  43
  44 public:
  45     HtcpReplyData();
  46     int hit;
  47     HttpHeader hdr;
  48     u_int32_t msg_id;
  49     double version;
  50
  51     struct cto_t
  52     {
  53         /* cache-to-origin */
  54         double rtt;
  55         int samp;
  56         int hops;
  57     } cto;
  58 };
  59
  60 /// \bug redundant typedef
  61 typedef class HtcpReplyData htcpReplyData;
  62
  63 /// \ingroup ServerProtocolHTCP
  64 SQUIDCEXTERN void neighborsHtcpReply(const cache_key *, htcpReplyData *, const IPAddress &);
  65
  66 /// \ingroup ServerProtocolHTCP
  67 SQUIDCEXTERN void htcpInit(void);
  68
  69 /// \ingroup ServerProtocolHTCP
  70 SQUIDCEXTERN void htcpQuery(StoreEntry * e, HttpRequest * req, peer * p);
  71
  72 /// \ingroup ServerProtocolHTCP
  73 SQUIDCEXTERN void htcpClear(StoreEntry * e, const char *uri, HttpRequest * req, const HttpRequestMethod &method, peer * p, htcp_clr_reason reason);
  74
  75 /// \ingroup ServerProtocolHTCP
  76 SQUIDCEXTERN void htcpSocketShutdown(void);
  77
  78 /// \ingroup ServerProtocolHTCP
  79 SQUIDCEXTERN void htcpSocketClose(void);
  80
  81 #endif /* USE_HTCP */
  82
  83 #endif /* SQUID_HTCP_H */