src/htcp.h

   1 /*
   2  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   3  * ----------------------------------------------------------
   4  *
   5  *  Squid is the result of efforts by numerous individuals from
   6  *  the Internet community; see the CONTRIBUTORS file for full
   7  *  details.   Many organizations have provided support for Squid's
   8  *  development; see the SPONSORS file for full details.  Squid is
   9  *  Copyrighted (C) 2001 by the Regents of the University of
  10  *  California; see the COPYRIGHT file for full details.  Squid
  11  *  incorporates software developed and/or copyrighted by other
  12  *  sources; see the CREDITS file for full details.
  13  *
  14  *  This program is free software; you can redistribute it and/or modify
  15  *  it under the terms of the GNU General Public License as published by
  16  *  the Free Software Foundation; either version 2 of the License, or
  17  *  (at your option) any later version.
  18  *
  19  *  This program is distributed in the hope that it will be useful,
  20  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  *  GNU General Public License for more details.
  23  *
  24  *  You should have received a copy of the GNU General Public License
  25  *  along with this program; if not, write to the Free Software
  26  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  27  *
  28  */
  29
  30 #ifndef SQUID_HTCP_H
  31 #define SQUID_HTCP_H
  32
  33 #if USE_HTCP
  34
  35 #include "HttpHeader.h"
  36 #include "HttpRequestMethod.h"
  37 #include "ip/forward.h"
  38
  39 class HttpRequest;
  40
  41 /// \ingroup ServerProtocolHTCP
  42 class HtcpReplyData
  43 {
  44
  45 public:
  46     HtcpReplyData();
  47     int hit;
  48     HttpHeader hdr;
  49     uint32_t msg_id;
  50     double version;
  51
  52     struct cto_t {
  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 void neighborsHtcpReply(const cache_key *, htcpReplyData *, const Ip::Address &);
  65
  66 /// \ingroup ServerProtocolHTCP
  67 void htcpOpenPorts(void);
  68
  69 /**
  70  * \ingroup ServerProtocolHTCP
  71  *
  72  * Generate and Send an HTCP query to the specified peer.
  73  *
  74  * \param e
  75  * \param req
  76  * \param p
  77  * \retval 1    Successfully sent request.
  78  * \retval 0    Unable to send request at this time. HTCP may be shutting down or starting up.
  79  *              Don't wait for a reply or count in stats as sent.
  80  * \retval -1   Error sending request.
  81  */
  82 int htcpQuery(StoreEntry * e, HttpRequest * req, CachePeer * p);
  83
  84 /// \ingroup ServerProtocolHTCP
  85 void htcpClear(StoreEntry * e, const char *uri, HttpRequest * req, const HttpRequestMethod &method, CachePeer * p, htcp_clr_reason reason);
  86
  87 /// \ingroup ServerProtocolHTCP
  88 void htcpSocketShutdown(void);
  89
  90 /// \ingroup ServerProtocolHTCP
  91 void htcpClosePorts(void);
  92
  93 #endif /* USE_HTCP */
  94
  95 #endif /* SQUID_HTCP_H */