HttpTunneler.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_CLIENTS_HTTPTUNNELER_H
#define SQUID_SRC_CLIENTS_HTTPTUNNELER_H
 
#include "base/AsyncCallbacks.h"
#include "base/AsyncJob.h"
#include "clients/forward.h"
#include "clients/HttpTunnelerAnswer.h"
#include "CommCalls.h"
#if USE_DELAY_POOLS
#include "DelayId.h"
#endif
#include "http/forward.h"
 
class ErrorState;
class AccessLogEntry;
typedef RefCount<AccessLogEntry> AccessLogEntryPointer;
 
namespace Http
{
 
class Tunneler: virtual public AsyncJob
{
    CBDATA_CHILD(Tunneler);
 
public:
    using Answer = TunnelerAnswer;
 
    Tunneler(const Comm::ConnectionPointer &, const HttpRequestPointer &, const AsyncCallback<Answer> &, time_t timeout, const AccessLogEntryPointer &);
    Tunneler(const Tunneler &) = delete;
    Tunneler &operator =(const Tunneler &) = delete;
 
#if USE_DELAY_POOLS
    void setDelayId(DelayId delay_id) {delayId = delay_id;}
#endif
 
    bool noteFwdPconnUse;
 
protected:
    /* AsyncJob API */
    ~Tunneler() override;
    void start() override;
    bool doneAll() const override;
    void swanSong() override;
    const char *status() const override;
 
    void handleConnectionClosure(const CommCloseCbParams&);
    void watchForClosures();
    void handleTimeout(const CommTimeoutCbParams &);
    void startReadingResponse();
    void writeRequest();
    void handleWrittenRequest(const CommIoCbParams&);
    void handleReadyRead(const CommIoCbParams&);
    void readMore();
    void handleResponse(const bool eof);
    void bailOnResponseError(const char *error, HttpReply *);
 
private:
    void bailWith(ErrorState*);
 
    void sendSuccess();
 
    void callBack();
 
    void disconnect();
 
    void countFailingConnection();
 
    AsyncCall::Pointer writer; 
    AsyncCall::Pointer reader; 
    AsyncCall::Pointer closer; 
 
    Comm::ConnectionPointer connection; 
    HttpRequestPointer request; 
    AsyncCallback<Answer> callback; 
    SBuf url; 
    time_t lifetimeLimit; 
    AccessLogEntryPointer al; 
#if USE_DELAY_POOLS
    DelayId delayId;
#endif
 
    SBuf readBuf; 
    Http1::ResponseParserPointer hp;
 
    const time_t startTime; 
 
    bool requestWritten; 
    bool tunnelEstablished; 
};
 
} // namespace Http
 
#endif /* SQUID_SRC_CLIENTS_HTTPTUNNELER_H */