Initiator.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 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_SRC_ADAPTATION_INITIATOR_H
#define SQUID_SRC_ADAPTATION_INITIATOR_H
 
#include "adaptation/forward.h"
#include "base/AsyncJob.h"
#include "base/CbcPointer.h"
 
/*
 * The ICAP Initiator is an ICAP vectoring point that initiates ICAP
 * transactions. This interface exists to allow ICAP transactions to
 * signal their initiators that they have the answer from the ICAP server
 * or that the ICAP query has aborted and there will be no answer. It
 * is also handy for implementing common initiator actions such as starting
 * or aborting an ICAP transaction.
 */
 
namespace Adaptation
{
 
class Initiator: virtual public AsyncJob
{
public:
    Initiator(): AsyncJob("Initiator") {}
    ~Initiator() override {}
 
    virtual void noteAdaptationAclCheckDone(Adaptation::ServiceGroupPointer group);
    virtual void noteAdaptationAnswer(const Answer &answer) = 0;
 
protected:
    CbcPointer<Initiate> initiateAdaptation(Initiate *x);
 
    void clearAdaptation(CbcPointer<Initiate> &x);
 
    void announceInitiatorAbort(CbcPointer<Initiate> &x);
 
    bool initiated(const CbcPointer<AsyncJob> &job) const { return job.set(); }
};
 
} // namespace Adaptation
 
#endif /* SQUID_SRC_ADAPTATION_INITIATOR_H */