SourceFormat Enforcement

[thirdparty/squid.git] / src / adaptation / icap / Launcher.h

diff --git a/src/adaptation/icap/Launcher.h b/src/adaptation/icap/Launcher.h
index 7c76b96ee0e9dd03928d2eb9d198acfb5c387c61..9db18e17ecc958ec1eca8cd42908ee203e1ce092 100644 (file)
--- a/src/adaptation/icap/Launcher.h
+++ b/src/adaptation/icap/Launcher.h
@@ -1,42 +1,17 @@
-
 /*
- * $Id$
- *
- *
- * SQUID Web Proxy Cache          http://www.squid-cache.org/
- * ----------------------------------------------------------
- *
- *  Squid is the result of efforts by numerous individuals from
- *  the Internet community; see the CONTRIBUTORS file for full
- *  details.   Many organizations have provided support for Squid's
- *  development; see the SPONSORS file for full details.  Squid is
- *  Copyrighted (C) 2001 by the Regents of the University of
- *  California; see the COPYRIGHT file for full details.  Squid
- *  incorporates software developed and/or copyrighted by other
- *  sources; see the CREDITS file for full details.
- *
- *  This program is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
- *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
- *
- *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
+ * Copyright (C) 1996-2017 The Squid Software Foundation and contributors
  *
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
  */
 
 #ifndef SQUID_ICAPLAUNCHER_H
 #define SQUID_ICAPLAUNCHER_H
 
-#include "adaptation/Initiator.h"
-#include "adaptation/Initiate.h"
 #include "adaptation/icap/ServiceRep.h"
+#include "adaptation/Initiate.h"
+#include "adaptation/Initiator.h"
 
 /*
  * The ICAP Launcher starts an ICAP transaction. If the transaction fails
@@ -58,12 +33,13 @@
  * ICAP transactions.
  */
 
-
 namespace Adaptation
 {
-namespace Icap {
+namespace Icap
+{
 
 class Xaction;
+class XactAbortInfo;
 
 // Note: Initiate must be the first parent for cbdata to work. We use
 // a temporary InitaitorHolder/toCbdata hacks and do not call cbdata
@@ -71,15 +47,19 @@ class Xaction;
 class Launcher: public Adaptation::Initiate, public Adaptation::Initiator
 {
 public:
-    Launcher(const char *aTypeName, Adaptation::Initiator *anInitiator, Adaptation::ServicePointer &aService);
+    Launcher(const char *aTypeName, Adaptation::ServicePointer &aService);
     virtual ~Launcher();
 
     // Adaptation::Initiate: asynchronous communication with the initiator
     void noteInitiatorAborted();
 
     // Adaptation::Initiator: asynchronous communication with the current transaction
-    virtual void noteAdaptationAnswer(HttpMsg *message);
-    virtual void noteAdaptationQueryAbort(bool final);
+    virtual void noteAdaptationAnswer(const Answer &answer);
+    virtual void noteXactAbort(XactAbortInfo info);
+
+private:
+    bool canRetry(XactAbortInfo &info) const; //< true if can retry in the case of persistent connection failures
+    bool canRepeat(XactAbortInfo &info) const; //< true if can repeat in the case of no or unsatisfactory response
 
 protected:
     // Adaptation::Initiate API implementation
@@ -90,14 +70,45 @@ protected:
     // creates the right ICAP transaction using stored configuration params
     virtual Xaction *createXaction() = 0;
 
-    void launchXaction(bool final);
+    void launchXaction(const char *xkind);
 
-    Adaptation::Initiate *theXaction; // current ICAP transaction
+    Adaptation::ServicePointer theService; ///< ICAP service for all launches
+    CbcPointer<Initiate> theXaction; ///< current ICAP transaction
     int theLaunches; // the number of transaction launches
 };
 
+/// helper class to pass information about aborted ICAP requests to
+/// the Adaptation::Icap::Launcher class
+class XactAbortInfo
+{
+public:
+    XactAbortInfo(HttpRequest *anIcapRequest, HttpReply *anIcapReply,
+                  bool beRetriable, bool beRepeatable);
+    XactAbortInfo(const XactAbortInfo &);
+    ~XactAbortInfo();
+
+    std::ostream &print(std::ostream &os) const {
+        return os << isRetriable << ',' << isRepeatable;
+    }
+
+    HttpRequest *icapRequest;
+    HttpReply *icapReply;
+    bool isRetriable;
+    bool isRepeatable;
+
+private:
+    XactAbortInfo &operator =(const XactAbortInfo &); // undefined
+};
+
+inline
+std::ostream &
+operator <<(std::ostream &os, const XactAbortInfo &xai)
+{
+    return xai.print(os);
+}
 
 } // namespace Icap
 } // namespace Adaptation
 
 #endif /* SQUID_ICAPLAUNCHER_H */
+