-
/*
- * $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-2018 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_ICAPSERVICEREP_H
#define SQUID_ICAPSERVICEREP_H
-#include "cbdata.h"
-#include "FadingCounter.h"
-#include "adaptation/Service.h"
#include "adaptation/forward.h"
-#include "adaptation/Initiator.h"
#include "adaptation/icap/Elements.h"
-
+#include "adaptation/Initiator.h"
+#include "adaptation/Service.h"
+#include "base/AsyncJobCalls.h"
+#include "cbdata.h"
+#include "comm.h"
+#include "FadingCounter.h"
+#include "pconn.h"
+#include <deque>
namespace Adaptation
{
* auto-destroyed by refcounting when no longer used.
*/
-
class ServiceRep : public RefCountable, public Adaptation::Service,
- public Adaptation::Initiator
+ public Adaptation::Initiator
{
+ CBDATA_CLASS(ServiceRep);
public:
typedef RefCount<ServiceRep> Pointer;
public:
- ServiceRep(const Adaptation::ServiceConfig &config);
+ explicit ServiceRep(const ServiceConfigPointer &aConfig);
virtual ~ServiceRep();
virtual void finalize();
virtual bool probed() const; // see comments above
virtual bool up() const; // see comments above
+ bool availableForNew() const; ///< a new transaction may start communicating with the service
+ bool availableForOld() const; ///< a transaction notified about connection slot availability may start communicating with the service
- virtual Adaptation::Initiate *makeXactLauncher(Adaptation::Initiator *, HttpMsg *virginHeader, HttpRequest *virginCause);
+ virtual Initiate *makeXactLauncher(Http::Message *virginHeader, HttpRequest *virginCause, AccessLogEntry::Pointer &alp);
+ void callWhenAvailable(AsyncCall::Pointer &cb, bool priority = false);
void callWhenReady(AsyncCall::Pointer &cb);
// the methods below can only be called on an up() service
- bool wantsUrl(const String &urlPath) const;
- bool wantsPreview(const String &urlPath, size_t &wantedSize) const;
+ bool wantsUrl(const SBuf &urlPath) const;
+ bool wantsPreview(const SBuf &urlPath, size_t &wantedSize) const;
bool allows204() const;
+ bool allows206() const;
+ Comm::ConnectionPointer getConnection(bool isRetriable, bool &isReused);
+ void putConnection(const Comm::ConnectionPointer &conn, bool isReusable, bool sendReset, const char *comment);
+ void noteConnectionUse(const Comm::ConnectionPointer &conn);
+ void noteConnectionFailed(const char *comment);
void noteFailure(); // called by transactions to report service failure
+ void noteNewWaiter() {theAllWaiters++;} ///< New xaction waiting for service to be up or available
+ void noteGoneWaiter(); ///< An xaction is not waiting any more for service to be available
+ bool existWaiters() const {return (theAllWaiters > 0);} ///< if there are xactions waiting for the service to be available
+
//AsyncJob virtual methods
virtual bool doneAll() const { return Adaptation::Initiator::doneAll() && false;}
+ virtual void callException(const std::exception &e);
virtual void detach();
virtual bool detached() const;
void noteTimeToNotify();
// receive either an ICAP OPTIONS response header or an abort message
- virtual void noteAdaptationAnswer(HttpMsg *msg);
- virtual void noteAdaptationQueryAbort(bool);
+ virtual void noteAdaptationAnswer(const Answer &answer);
+
+ Security::ContextPointer sslContext;
+ Security::SessionStatePointer sslSession;
private:
// stores Prepare() callback info
AsyncCall::Pointer callback;
};
- typedef Vector<Client> Clients;
+ typedef std::vector<Client> Clients;
+ // TODO: rename to theUpWaiters
Clients theClients; // all clients waiting for a call back
Options *theOptions;
- Adaptation::Initiate *theOptionsFetcher; // pending ICAP OPTIONS transaction
+ CbcPointer<Adaptation::Initiate> theOptionsFetcher; // pending ICAP OPTIONS transaction
time_t theLastUpdate; // time the options were last updated
+ /// FIFO queue of xactions waiting for a connection slot and not yet notified
+ /// about it; xaction is removed when notification is scheduled
+ std::deque<Client> theNotificationWaiters;
+ int theBusyConns; ///< number of connections given to active transactions
+ /// number of xactions waiting for a connection slot (notified and not)
+ /// the number is decreased after the xaction receives notification
+ int theAllWaiters;
+ int theMaxConnections; ///< the maximum allowed connections to the service
+ // TODO: use a better type like the FadingCounter for connOverloadReported
+ mutable bool connOverloadReported; ///< whether we reported exceeding theMaxConnections
+ IdleConnList *theIdleConns; ///< idle persistent connection pool
+
FadingCounter theSessionFailures;
const char *isSuspended; // also stores suspension reason for debugging
void announceStatusChange(const char *downPhrase, bool important) const;
+ /// Set the maximum allowed connections for the service
+ void setMaxConnections();
+ /// The number of connections which excess the Max-Connections limit
+ int excessConnections() const;
+ /**
+ * The available connections slots to the ICAP server
+ \return the available slots, or -1 if there is no limit on allowed connections
+ */
+ int availableConnections() const;
+ /**
+ * If there are xactions waiting for the service to be available, notify
+ * as many xactions as the available connections slots.
+ */
+ void busyCheckpoint();
+
const char *status() const;
mutable bool wasAnnouncedUp; // prevent sequential same-state announcements
bool isDetached;
- CBDATA_CLASS2(ServiceRep);
};
+class ModXact;
+/// Custom dialer to call Service::noteNewWaiter and noteGoneWaiter
+/// to maintain Service idea of waiting and being-notified transactions.
+class ConnWaiterDialer: public NullaryMemFunT<ModXact>
+{
+public:
+ typedef NullaryMemFunT<ModXact> Parent;
+ ServiceRep::Pointer theService;
+ ConnWaiterDialer(const CbcPointer<Adaptation::Icap::ModXact> &xact, Adaptation::Icap::ConnWaiterDialer::Parent::Method aHandler);
+ ConnWaiterDialer(const Adaptation::Icap::ConnWaiterDialer &aConnWaiter);
+ ~ConnWaiterDialer();
+};
} // namespace Icap
} // namespace Adaptation
#endif /* SQUID_ICAPSERVICEREP_H */
+
projects / thirdparty / squid.git / blobdiff