Iterator.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_ITERATOR_H
#define SQUID_SRC_ADAPTATION_ITERATOR_H
 
#include "adaptation/Initiate.h"
#include "adaptation/Initiator.h"
#include "adaptation/ServiceGroups.h"
#include "http/forward.h"
#include "log/forward.h"
 
namespace Adaptation
{
 
/* Iterator is started by client or server Initiators. It iterates services
   in a given group, starting transaction launcher for each service, according
   to the service plan. Service plans support adaptation sets and chains.
 
   Note: Initiate must be the first parent for cbdata to work. We use
   a temporary InitiatorHolder/toCbdata hacks and do not call cbdata
   operations on the initiator directly.
*/
 
class Iterator: public Initiate, public Initiator
{
    CBDATA_CHILD(Iterator);
 
public:
    Iterator(Http::Message *virginHeader, HttpRequest *virginCause,
             const AccessLogEntryPointer &,
             const Adaptation::ServiceGroupPointer &aGroup);
    ~Iterator() override;
 
    // Adaptation::Initiate: asynchronous communication with the initiator
    void noteInitiatorAborted() override;
 
    // Adaptation::Initiator: asynchronous communication with the current launcher
    void noteAdaptationAnswer(const Answer &answer) override;
 
protected:
    // Adaptation::Initiate API implementation
    void start() override;
    bool doneAll() const override;
    void swanSong() override;
 
    void step();
 
    bool updatePlan(bool adopt); // returns true iff the plan was replaced
 
    ServiceFilter filter() const;
 
    void handleAdaptedHeader(Http::Message *msg);
    void handleAdaptationBlock(const Answer &answer);
    void handleAdaptationError(bool final);
 
    ServiceGroupPointer theGroup; 
    ServicePlan thePlan; 
    Http::Message *theMsg; 
    HttpRequest *theCause; 
    AccessLogEntryPointer al; 
    CbcPointer<Adaptation::Initiate> theLauncher; 
    int iterations; 
    bool adapted; 
};
 
} // namespace Adaptation
 
#endif /* SQUID_SRC_ADAPTATION_ITERATOR_H */