src/ICP.h

   1 /*
   2  * $Id$
   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_ICP_H
  34 #define SQUID_ICP_H
  35
  36 /**
  37  \defgroup ServerProtocolICPAPI ICP
  38  \ingroup ServerProtocol
  39  */
  40
  41 #include "StoreClient.h"
  42
  43 /**
  44  \ingroup ServerProtocolICPAPI
  45  *
  46  * This struct is the wire-level header.
  47  * DO NOT add more move fields on pain of breakage.
  48  * DO NOT add virtual methods.
  49  */
  50 struct _icp_common_t {
  51     /** opcode */
  52     unsigned char opcode;
  53     /** version number */
  54     unsigned char version;
  55     /** total length (bytes) */
  56     unsigned short length;
  57     /** req number (req'd for UDP) */
  58     u_int32_t reqnum;
  59     u_int32_t flags;
  60     u_int32_t pad;
  61     /** sender host id */
  62     u_int32_t shostid;
  63
  64 /// \todo I don't believe this header is included in non-c++ code anywhere
  65 ///             the struct should become a public POD class and kill these #ifdef.
  66 #ifdef __cplusplus
  67
  68     _icp_common_t();
  69     _icp_common_t(char *buf, unsigned int len);
  70
  71     void handleReply(char *buf, IpAddress &from);
  72     static _icp_common_t *createMessage(icp_opcode opcode, int flags, const char *url, int reqnum, int pad);
  73     icp_opcode getOpCode() const;
  74 #endif
  75 };
  76
  77 #ifdef __cplusplus
  78
  79 /// \ingroup ServerProtocolICPAPI
  80 inline icp_opcode & operator++ (icp_opcode & aCode)
  81 {
  82     int tmp = (int) aCode;
  83     aCode = (icp_opcode) (++tmp);
  84     return aCode;
  85 }
  86
  87
  88 /**
  89  \ingroup ServerProtocolICPAPI
  90  \todo mempool this
  91  */
  92 class ICPState
  93 {
  94
  95 public:
  96     ICPState(icp_common_t &aHeader, HttpRequest *aRequest);
  97     virtual ~ICPState();
  98     icp_common_t header;
  99     HttpRequest *request;
 100     int fd;
 101
 102     IpAddress from;
 103     char *url;
 104 };
 105
 106 #endif
 107
 108 /// \ingroup ServerProtocolICPAPI
 109 struct icpUdpData {
 110     IpAddress address;
 111     void *msg;
 112     size_t len;
 113     icpUdpData *next;
 114 #ifndef LESS_TIMING
 115
 116     struct timeval start;
 117 #endif
 118
 119     log_type logcode;
 120
 121     struct timeval queue_time;
 122 };
 123
 124 /// \ingroup ServerProtocolICPAPI
 125 HttpRequest* icpGetRequest(char *url, int reqnum, int fd, IpAddress &from);
 126
 127 /// \ingroup ServerProtocolICPAPI
 128 int icpAccessAllowed(IpAddress &from, HttpRequest * icp_request);
 129
 130 /// \ingroup ServerProtocolICPAPI
 131 SQUIDCEXTERN void icpCreateAndSend(icp_opcode, int flags, char const *url, int reqnum, int pad, int fd, const IpAddress &from);
 132
 133 /// \ingroup ServerProtocolICPAPI
 134 extern icp_opcode icpGetCommonOpcode();
 135
 136 /// \ingroup ServerProtocolICPAPI
 137 SQUIDCEXTERN int icpUdpSend(int, const IpAddress &, icp_common_t *, log_type, int);
 138
 139 /// \ingroup ServerProtocolICPAPI
 140 SQUIDCEXTERN log_type icpLogFromICPCode(icp_opcode opcode);
 141
 142 /// \ingroup ServerProtocolICPAPI
 143 void icpDenyAccess(IpAddress &from, char *url, int reqnum, int fd);
 144
 145 /// \ingroup ServerProtocolICPAPI
 146 SQUIDCEXTERN PF icpHandleUdp;
 147
 148 /// \ingroup ServerProtocolICPAPI
 149 SQUIDCEXTERN PF icpUdpSendQueue;
 150
 151 /// \ingroup ServerProtocolICPAPI
 152 SQUIDCEXTERN void icpHandleIcpV3(int, IpAddress &, char *, int);
 153
 154 /// \ingroup ServerProtocolICPAPI
 155 SQUIDCEXTERN int icpCheckUdpHit(StoreEntry *, HttpRequest * request);
 156
 157 /// \ingroup ServerProtocolICPAPI
 158 SQUIDCEXTERN void icpConnectionsOpen(void);
 159
 160 /// \ingroup ServerProtocolICPAPI
 161 SQUIDCEXTERN void icpConnectionShutdown(void);
 162
 163 /// \ingroup ServerProtocolICPAPI
 164 SQUIDCEXTERN void icpConnectionClose(void);
 165
 166 /// \ingroup ServerProtocolICPAPI
 167 SQUIDCEXTERN int icpSetCacheKey(const cache_key * key);
 168
 169 /// \ingroup ServerProtocolICPAPI
 170 SQUIDCEXTERN const cache_key *icpGetCacheKey(const char *url, int reqnum);
 171
 172 #endif /* SQUID_ICP_H */