Prep for 3.3.12 and 3.4.4

[thirdparty/squid.git] / src / PeerSelectState.h

diff --git a/src/PeerSelectState.h b/src/PeerSelectState.h
index 8939e40e1d31e8b735fb2a6f849aa4b736b3905c..3bd6bd196bd9d3ac3ed1930b8a4a70ac26576faf 100644 (file)
--- a/src/PeerSelectState.h
+++ b/src/PeerSelectState.h
@@ -1,7 +1,4 @@
-
 /*
- * $Id: PeerSelectState.h,v 1.3 2007/12/14 23:11:45 amosjeffries Exp $
- *
  * AUTHOR: Robert Collins
  *
  * SQUID Web Proxy Cache          http://www.squid-cache.org/
@@ -36,46 +33,85 @@
 #ifndef   SQUID_PEERSELECTSTATE_H
 #define   SQUID_PEERSELECTSTATE_H
 
+#include "AccessLogEntry.h"
+#include "acl/Checklist.h"
 #include "cbdata.h"
+#include "comm/forward.h"
+#include "hier_code.h"
+#include "ip/Address.h"
 #include "PingData.h"
-#include "IPAddress.h"
+
+class HttpRequest;
+class StoreEntry;
+class ErrorState;
+
+typedef void PSC(Comm::ConnectionList *, ErrorState *, void *);
+
+void peerSelect(Comm::ConnectionList *, HttpRequest *, AccessLogEntry::Pointer const&, StoreEntry *, PSC *, void *data);
+void peerSelectInit(void);
+
+/**
+ * A CachePeer which has been selected as a possible destination.
+ * Listed as pointers here so as to prevent duplicates being added but will
+ * be converted to a set of IP address path options before handing back out
+ * to the caller.
+ *
+ * Certain connection flags and outgoing settings will also be looked up and
+ * set based on the received request and CachePeer settings before handing back.
+ */
+class FwdServer
+{
+public:
+    CachePeer *_peer;                /* NULL --> origin server */
+    hier_code code;
+    FwdServer *next;
+};
 
 class ps_state
 {
 
 public:
-    void *operator new(size_t);
     ps_state();
+    ~ps_state();
+
+    // Produce a URL for display identifying the transaction we are
+    // trying to locate a peer for.
+    const char * url() const;
+
     HttpRequest *request;
+    AccessLogEntry::Pointer al; ///< info for the future access.log entry
     StoreEntry *entry;
-    int always_direct;
-    int never_direct;
-    int direct;
+    allow_t always_direct;
+    allow_t never_direct;
+    int direct;   // TODO: fold always_direct/never_direct/prefer_direct into this now that ACL can do a multi-state result.
     PSC *callback;
     void *callback_data;
-    FwdServer *servers;
+    ErrorState *lastError;
+
+    Comm::ConnectionList *paths;    ///< the callers paths array. to be filled with our final results.
+    FwdServer *servers;    ///< temporary linked list of peers we will pass back.
+
     /*
-     * Why are these IPAddress instead of peer *?  Because a
-     * peer structure can become invalid during the peer selection
+     * Why are these Ip::Address instead of CachePeer *?  Because a
+     * CachePeer structure can become invalid during the CachePeer selection
      * phase, specifically after a reconfigure.  Thus we need to lookup
-     * the peer * based on the address when we are finally ready to
-     * reference the peer structure.
+     * the CachePeer * based on the address when we are finally ready to
+     * reference the CachePeer structure.
      */
 
-    IPAddress first_parent_miss;
+    Ip::Address first_parent_miss;
 
-    IPAddress closest_parent_miss;
+    Ip::Address closest_parent_miss;
     /*
-     * ->hit can be peer* because it should only be
+     * ->hit can be CachePeer* because it should only be
      * accessed during the thread when it is set
      */
-    peer *hit;
+    CachePeer *hit;
     peer_t hit_type;
     ping_data ping;
     ACLChecklist *acl_checklist;
 private:
-    CBDATA_CLASS(ps_state);
+    CBDATA_CLASS2(ps_state);
 };
 
-
 #endif /* SQUID_PEERSELECTSTATE_H */