src/adaptation/Answer.h

   1 /*
   2  * Copyright (C) 1996-2023 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 #ifndef SQUID_ADAPTATION__ANSWER_H
  10 #define SQUID_ADAPTATION__ANSWER_H
  11
  12 #include "adaptation/forward.h"
  13 #include "http/forward.h"
  14 #include "SquidString.h"
  15
  16 #include <iosfwd>
  17
  18 namespace Adaptation
  19 {
  20
  21 /// summarizes adaptation service answer for the noteAdaptationAnswer() API
  22 class Answer
  23 {
  24 public:
  25     /// helps interpret other members without a class hierarchy
  26     typedef enum {
  27         akForward, ///< forward the supplied adapted HTTP message
  28         akBlock, ///< block or deny the master xaction; see authority
  29         akError, ///< no adapted message will come; see bypassable
  30     } Kind;
  31
  32     static Answer Error(bool final); ///< create an akError answer
  33     static Answer Forward(Http::Message *aMsg); ///< create an akForward answer
  34     static Answer Block(const String &aRule); ///< create an akBlock answer
  35
  36     std::ostream &print(std::ostream &os) const;
  37
  38 public:
  39     Http::MessagePointer message; ///< HTTP request or response to forward
  40     String ruleId; ///< ACL (or similar rule) name that blocked forwarding
  41     bool final; ///< whether the error, if any, cannot be bypassed
  42     Kind kind; ///< the type of the answer
  43
  44 private:
  45     explicit Answer(Kind aKind); ///< use static creators instead
  46 };
  47
  48 inline
  49 std::ostream &operator <<(std::ostream &os, const Answer &answer)
  50 {
  51     return answer.print(os);
  52 }
  53
  54 } // namespace Adaptation
  55
  56 #endif /* SQUID_ADAPTATION__ANSWER_H */
  57