2 * Copyright (C) 1996-2016 The Squid Software Foundation and contributors
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.
9 #ifndef SQUID_ADAPTATION__ITERATOR_H
10 #define SQUID_ADAPTATION__ITERATOR_H
12 #include "AccessLogEntry.h"
13 #include "adaptation/Initiate.h"
14 #include "adaptation/Initiator.h"
15 #include "adaptation/ServiceGroups.h"
23 /* Iterator is started by client or server Initiators. It iterates services
24 in a given group, starting transaction launcher for each service, according
25 to the service plan. Service plans support adaptation sets and chains.
27 Note: Initiate must be the first parent for cbdata to work. We use
28 a temporary InitiatorHolder/toCbdata hacks and do not call cbdata
29 operations on the initiator directly.
32 /// iterates services in ServiceGroup, starting adaptation launchers
33 class Iterator
: public Initiate
, public Initiator
35 CBDATA_CLASS(Iterator
);
38 Iterator(HttpMsg
*virginHeader
, HttpRequest
*virginCause
,
39 AccessLogEntry::Pointer
&alp
,
40 const Adaptation::ServiceGroupPointer
&aGroup
);
43 // Adaptation::Initiate: asynchronous communication with the initiator
44 void noteInitiatorAborted();
46 // Adaptation::Initiator: asynchronous communication with the current launcher
47 virtual void noteAdaptationAnswer(const Answer
&answer
);
50 // Adaptation::Initiate API implementation
52 virtual bool doneAll() const;
53 virtual void swanSong();
55 /// launches adaptation for the service selected by the plan
58 /// replace the current group and plan with service-proposed ones if needed
59 bool updatePlan(bool adopt
); // returns true iff the plan was replaced
61 /// creates service filter for the current step
62 ServiceFilter
filter() const;
64 void handleAdaptedHeader(HttpMsg
*msg
);
65 void handleAdaptationBlock(const Answer
&answer
);
66 void handleAdaptationError(bool final
);
68 ServiceGroupPointer theGroup
; ///< the service group we are iterating
69 ServicePlan thePlan
; ///< which services to use and in what order
70 HttpMsg
*theMsg
; ///< the message being adapted (virgin for each step)
71 HttpRequest
*theCause
; ///< the cause of the original virgin message
72 AccessLogEntry::Pointer al
; ///< info for the future access.log entry
73 CbcPointer
<Adaptation::Initiate
> theLauncher
; ///< current transaction launcher
74 int iterations
; ///< number of steps initiated
75 bool adapted
; ///< whether the virgin message has been replaced
78 } // namespace Adaptation
80 #endif /* SQUID_ADAPTATION__ITERATOR_H */