src/mgr/Forwarder.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 16    Cache Manager API */
  10
  11 #ifndef SQUID_MGR_FORWARDER_H
  12 #define SQUID_MGR_FORWARDER_H
  13
  14 #include "comm/forward.h"
  15 #include "ipc/Forwarder.h"
  16 #include "mgr/ActionParams.h"
  17
  18 class CommCloseCbParams;
  19 class HttpRequest;
  20 class StoreEntry;
  21 class ErrorState;
  22
  23 namespace Mgr
  24 {
  25
  26 /** Forwards a single client cache manager request to Coordinator.
  27  * Waits for an ACK from Coordinator while holding the Store entry.
  28  * Fills the store entry with an error response if forwarding fails.
  29  */
  30 class Forwarder: public Ipc::Forwarder
  31 {
  32     CBDATA_CLASS(Forwarder);
  33
  34 public:
  35     Forwarder(const Comm::ConnectionPointer &aConn, const ActionParams &aParams, HttpRequest* aRequest,
  36               StoreEntry* anEntry);
  37     virtual ~Forwarder();
  38
  39 protected:
  40     /* Ipc::Forwarder API */
  41     virtual void cleanup(); ///< perform cleanup actions
  42     virtual void handleError();
  43     virtual void handleTimeout();
  44     virtual void handleException(const std::exception& e);
  45     virtual void handleRemoteAck();
  46
  47 private:
  48     void noteCommClosed(const CommCloseCbParams& params);
  49     void sendError(ErrorState* error);
  50
  51 private:
  52     HttpRequest* httpRequest; ///< HTTP client request for detailing errors
  53     StoreEntry* entry; ///< Store entry expecting the response
  54     Comm::ConnectionPointer conn; ///< HTTP client connection descriptor
  55     AsyncCall::Pointer closer; ///< comm_close handler for the HTTP connection
  56 };
  57
  58 } // namespace Mgr
  59
  60 #endif /* SQUID_MGR_FORWARDER_H */
  61