Client.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2021 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_SRC_CLIENTS_CLIENT_H
10 #define SQUID_SRC_CLIENTS_CLIENT_H
11 
12 #include "base/AsyncJob.h"
13 #include "BodyPipe.h"
14 #include "CommCalls.h"
15 #include "FwdState.h"
16 #include "http/forward.h"
17 #include "StoreIOBuffer.h"
18 #if USE_ADAPTATION
19 #include "adaptation/forward.h"
20 #include "adaptation/Initiator.h"
21 #endif
22 
29 class Client:
30 #if USE_ADAPTATION
31  public Adaptation::Initiator,
32  public BodyProducer,
33 #endif
34  public BodyConsumer
35 {
36 
37 public:
38  Client(FwdState *);
39  virtual ~Client();
40 
42  virtual const Comm::ConnectionPointer & dataConnection() const = 0;
43 
44  // BodyConsumer: consume request body or adapted response body.
45  // The implementation just calls the corresponding HTTP or ICAP handle*()
46  // method, depending on the pipe.
50 
52  virtual void maybeReadVirginBody() = 0;
53 
55  virtual void abortAll(const char *reason) = 0;
56 
60  virtual bool abortOnData(const char *reason);
61 
64 
65 #if USE_ADAPTATION
66  // Adaptation::Initiator API: start an ICAP transaction and receive adapted headers.
67  virtual void noteAdaptationAnswer(const Adaptation::Answer &answer);
69 
70  // BodyProducer: provide virgin response body to ICAP.
73 #endif
74  virtual bool getMoreRequestBody(MemBuf &buf);
75  virtual void processReplyBody() = 0;
76 
77 //AsyncJob virtual methods
78  virtual void swanSong();
79  virtual bool doneAll() const;
80 
81 public: // should be protected
82  void serverComplete();
84  void markParsedVirginReplyAsWhole(const char *reasonWeAreSure);
87 
88 private:
89  void serverComplete2();
90  bool completed = false;
92 protected:
93  // kids customize these
94  virtual void haveParsedReplyHeaders();
95  virtual void completeForwarding();
97  // BodyConsumer for HTTP: consume request body.
98  bool startRequestBodyFlow();
101  virtual void handleRequestBodyProducerAborted() = 0;
102 
103  // sending of the request body to the server
104  void sendMoreRequestBody();
105  // has body; kids overwrite to increment I/O stats counters
106  virtual void sentRequestBody(const CommIoCbParams &io) = 0;
107  virtual void doneSendingRequestBody() = 0;
108 
111  virtual void closeServer() = 0;
112  virtual bool doneWithServer() const = 0;
113  virtual bool mayReadVirginReplyBody() const = 0;
115 
117  bool abortOnBadEntry(const char *abortReason);
118 
119  bool blockCaching();
120 
121 #if USE_ADAPTATION
123  void adaptVirginReplyBody(const char *buf, ssize_t len);
124  void cleanAdaptation();
125  virtual bool doneWithAdaptation() const;
127  // BodyConsumer for ICAP: consume adapted response body.
131 
134  void handleAdaptationBlocked(const Adaptation::Answer &answer);
135  void handleAdaptationAborted(bool bypassable = false);
137 
139  void resumeBodyStorage();
142 #endif
143 
144 protected:
145  const HttpReply *virginReply() const;
148 
151 
152  // Kids use these to stuff data into the response instead of messing with the entry directly
153  void adaptOrFinalizeReply();
154  void addVirginReplyBody(const char *buf, ssize_t len);
155  void storeReplyBody(const char *buf, ssize_t len);
157  size_t replyBodySpace(const MemBuf &readBuf, const size_t minSpace) const;
159  size_t calcBufferSpaceToReserve(const size_t space, const size_t wantSpace) const;
160 
161  void adjustBodyBytesRead(const int64_t delta);
162 
163  // These should be private
164  int64_t currentOffset = 0;
167 public: // should not be
168  StoreEntry *entry = nullptr;
171 
172 protected:
176 #if USE_ADAPTATION
182  bool startedAdaptation = false;
183 
186 #endif
188 
191  const char *doneWithFwd = nullptr;
192 
193 private:
195  void maybePurgeOthers();
196 
199 };
200 
201 #endif /* SQUID_SRC_CLIENTS_CLIENT_H */
202 
virtual void noteMoreBodyDataAvailable(BodyPipe::Pointer)
Definition: Client.cc:271
void handleMoreRequestBodyAvailable()
Definition: Client.cc:320
void storeReplyBody(const char *buf, ssize_t len)
Definition: Client.cc:1046
HttpReply * theVirginReply
Definition: Client.h:197
virtual bool getMoreRequestBody(MemBuf &buf)
either fill buf with available [encoded] request body bytes or return false
Definition: Client.cc:439
StoreEntry * entry
Definition: Client.h:168
common parts of HttpRequest and HttpReply
Definition: Message.h:26
Definition: Client.h:35
void endAdaptedBodyConsumption()
called when the entire adapted response body is consumed
Definition: Client.cc:831
void adaptVirginReplyBody(const char *buf, ssize_t len)
Definition: Client.cc:630
virtual void swanSong()
Definition: Client.cc:69
bool completed
Definition: Client.h:90
AsyncCall::Pointer requestSender
Definition: Client.h:174
Client(FwdState *)
Definition: Client.cc:39
void handleAdaptationCompleted()
Definition: Client.cc:867
virtual void handleRequestBodyProducerAborted()=0
Definition: Client.cc:352
virtual void abortAll(const char *reason)=0
abnormal transaction termination; reason is for debugging only
void maybePurgeOthers()
Definition: Client.cc:517
void serverComplete2()
Definition: Client.cc:203
BodyPipe::Pointer requestBodySource
Definition: Client.h:173
virtual void noteBodyConsumerAborted(BodyPipe::Pointer)
Definition: Client.cc:686
virtual const Comm::ConnectionPointer & dataConnection() const =0
void cleanAdaptation()
Definition: Client.cc:605
void adjustBodyBytesRead(const int64_t delta)
initializes bodyBytesRead stats if needed and applies delta
Definition: Client.cc:1015
virtual void noteMoreBodySpaceAvailable(BodyPipe::Pointer)
Definition: Client.cc:672
void adaptOrFinalizeReply()
Definition: Client.cc:997
MemBuf * responseBodyBuffer
Definition: Client.h:165
virtual void noteBodyProductionEnded(BodyPipe::Pointer)
Definition: Client.cc:285
BodyPipe::Pointer virginBodyDestination
Definition: Client.h:177
bool startRequestBodyFlow()
Definition: Client.cc:240
virtual void haveParsedReplyHeaders()
called when we have final (possibly adapted) reply headers; kids extend
Definition: Client.cc:538
int64_t currentOffset
Definition: Client.h:164
virtual bool mayReadVirginReplyBody() const =0
whether we may receive more virgin response body bytes
virtual void noteAdaptationAclCheckDone(Adaptation::ServiceGroupPointer group)
Definition: Client.cc:958
void serverComplete()
Definition: Client.cc:181
virtual void completeForwarding()
Definition: Client.cc:231
void handleMoreAdaptedBodyAvailable()
Definition: Client.cc:769
void handleAdaptedHeader(Http::Message *msg)
Definition: Client.cc:718
virtual void doneSendingRequestBody()=0
Definition: Client.cc:341
void resumeBodyStorage()
called by StoreEntry when it has more buffer space available
Definition: Client.cc:753
const HttpReply * virginReply() const
Definition: Client.cc:110
HttpReply * theFinalReply
Definition: Client.h:198
bool blockCaching()
whether to prevent caching of an otherwise cachable response
Definition: Client.cc:553
virtual void noteBodyProducerAborted(BodyPipe::Pointer)
Definition: Client.cc:299
virtual void noteAdaptationAnswer(const Adaptation::Answer &answer)
Definition: Client.cc:698
virtual void processReplyBody()=0
Definition: MemBuf.h:24
void handleAdaptedBodyProducerAborted()
Definition: Client.cc:846
virtual ~Client()
Definition: Client.cc:48
void sendMoreRequestBody()
Definition: Client.cc:413
FwdState::Pointer fwd
Definition: Client.h:169
bool handledEarlyAdaptationAbort()
Definition: Client.cc:902
HttpReply * setFinalReply(HttpReply *r)
Definition: Client.cc:137
virtual HttpRequestPointer originalRequest()
a hack to reach HttpStateData::orignal_request
Definition: Client.cc:571
bool adaptationAccessCheckPending
Definition: Client.h:181
HttpReply * setVirginReply(HttpReply *r)
Definition: Client.cc:117
bool receivedWholeRequestBody
handleRequestBodyProductionEnded called
Definition: Client.h:187
HttpReply * finalReply()
Definition: Client.cc:130
bool abortOnBadEntry(const char *abortReason)
Entry-dependent callbacks use this check to quit if the entry went bad.
Definition: Client.cc:259
summarizes adaptation service answer for the noteAdaptationAnswer() API
Definition: Answer.h:23
void markParsedVirginReplyAsWhole(const char *reasonWeAreSure)
Definition: Client.cc:159
BodyPipe::Pointer adaptedBodySource
Definition: Client.h:179
virtual bool doneAll() const
whether positive goal has been reached
Definition: Client.cc:218
virtual bool doneWithAdaptation() const
Definition: Client.cc:622
void sendBodyIsTooLargeError()
Definition: Client.cc:986
size_t calcBufferSpaceToReserve(const size_t space, const size_t wantSpace) const
determine how much space the buffer needs to reserve
Definition: Client.cc:1055
void startAdaptation(const Adaptation::ServiceGroupPointer &group, HttpRequest *cause)
Initiate an asynchronous adaptation transaction which will call us back.
Definition: Client.cc:579
void handleAdaptationAborted(bool bypassable=false)
Definition: Client.cc:886
void addVirginReplyBody(const char *buf, ssize_t len)
Definition: Client.cc:1030
const char * doneWithFwd
Definition: Client.h:191
virtual void sentRequestBody(const CommIoCbParams &io)=0
Definition: Client.cc:365
void handleRequestBodyProductionEnded()
Definition: Client.cc:330
virtual void maybeReadVirginBody()=0
read response data from the network
virtual void closeServer()=0
virtual bool abortOnData(const char *reason)
Definition: Client.cc:312
void handleAdaptedBodyProductionEnded()
Definition: Client.cc:816
bool startedAdaptation
Definition: Client.h:182
bool receivedWholeAdaptedReply
handleAdaptedBodyProductionEnded() was called
Definition: Client.h:185
CbcPointer< Adaptation::Initiate > adaptedHeadSource
Definition: Client.h:178
size_t replyBodySpace(const MemBuf &readBuf, const size_t minSpace) const
Definition: Client.cc:1090
void handleAdaptationBlocked(const Adaptation::Answer &answer)
Definition: Client.cc:925
HttpRequestPointer request
Definition: Client.h:170
virtual bool doneWithServer() const =0

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors