src/neighbors.h

   1 /*
   2  * Copyright (C) 1996-2017 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 /* DEBUG: section 15    Neighbor Routines */
  10
  11 #ifndef SQUID_NEIGHBORS_H_
  12 #define SQUID_NEIGHBORS_H_
  13
  14 #include "enums.h"
  15 #include "ICP.h"
  16 #include "lookup_t.h"
  17 #include "typedefs.h" //for IRCB
  18
  19 class HttpRequest;
  20 class HttpRequestMethod;
  21 class CachePeer;
  22 class StoreEntry;
  23 class URL;
  24
  25 CachePeer *getFirstPeer(void);
  26 CachePeer *getFirstUpParent(HttpRequest *);
  27 CachePeer *getNextPeer(CachePeer *);
  28 CachePeer *getSingleParent(HttpRequest *);
  29 int neighborsCount(HttpRequest *);
  30 int neighborsUdpPing(HttpRequest *,
  31                      StoreEntry *,
  32                      IRCB * callback,
  33                      void *data,
  34                      int *exprep,
  35                      int *timeout);
  36 void neighborAddAcl(const char *, const char *);
  37
  38 void neighborsUdpAck(const cache_key *, icp_common_t *, const Ip::Address &);
  39 void neighborAdd(const char *, const char *, int, int, int, int, int);
  40 void neighbors_init(void);
  41 #if USE_HTCP
  42 void neighborsHtcpClear(StoreEntry *, const char *, HttpRequest *, const HttpRequestMethod &, htcp_clr_reason);
  43 #endif
  44 CachePeer *peerFindByName(const char *);
  45 CachePeer *peerFindByNameAndPort(const char *, unsigned short);
  46 CachePeer *getDefaultParent(HttpRequest * request);
  47 CachePeer *getRoundRobinParent(HttpRequest * request);
  48 CachePeer *getWeightedRoundRobinParent(HttpRequest * request);
  49 void peerClearRRStart(void);
  50 void peerClearRR(void);
  51 lookup_t peerDigestLookup(CachePeer * p, HttpRequest * request);
  52 CachePeer *neighborsDigestSelect(HttpRequest * request);
  53 void peerNoteDigestLookup(HttpRequest * request, CachePeer * p, lookup_t lookup);
  54 void peerNoteDigestGone(CachePeer * p);
  55 int neighborUp(const CachePeer * e);
  56 const char *neighborTypeStr(const CachePeer * e);
  57 peer_t neighborType(const CachePeer *, const URL &);
  58 void peerConnectFailed(CachePeer *);
  59 void peerConnectSucceded(CachePeer *);
  60 void dump_peer_options(StoreEntry *, CachePeer *);
  61 int peerHTTPOkay(const CachePeer *, HttpRequest *);
  62
  63 /// Whether we can open new connections to the peer (e.g., despite max-conn)
  64 bool peerCanOpenMore(const CachePeer *p);
  65 /// Whether the peer has idle or standby connections that can be used now
  66 bool peerHasConnAvailable(const CachePeer *p);
  67 /// Notifies peer of an associated connection closure.
  68 void peerConnClosed(CachePeer *p);
  69
  70 CachePeer *whichPeer(const Ip::Address &from);
  71
  72 #endif /* SQUID_NEIGHBORS_H_ */
  73