Server.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.
 */
 
/* DEBUG: section 33    Client-side Routines */
 
#ifndef SQUID_SRC_SERVERS_SERVER_H
#define SQUID_SRC_SERVERS_SERVER_H
 
#include "anyp/forward.h"
#include "anyp/ProtocolVersion.h"
#include "base/AsyncJob.h"
#include "BodyPipe.h"
#include "comm/Write.h"
#include "CommCalls.h"
#include "error/forward.h"
#include "http/Stream.h"
#include "log/forward.h"
#include "Pipeline.h"
#include "sbuf/SBuf.h"
#include "servers/forward.h"
 
class Server : virtual public AsyncJob, public BodyProducer
{
public:
    Server(const MasterXactionPointer &xact);
    ~Server() override {}
 
    /* AsyncJob API */
    void start() override;
    bool doneAll() const override;
    void swanSong() override;
 
    virtual bool shouldCloseOnEof() const = 0;
 
    void readSomeData();
 
    virtual bool handleReadData() = 0;
 
    virtual void afterClientRead() = 0;
 
    bool reading() const {return reader != nullptr;}
 
    void stopReading();
 
    virtual void receivedFirstByte() = 0;
 
    virtual void writeSomeData() {}
 
    void write(MemBuf *mb) {
        typedef CommCbMemFunT<Server, CommIoCbParams> Dialer;
        writer = JobCallback(33, 5, Dialer, this, Server::clientWriteDone);
        Comm::Write(clientConnection, mb, writer);
    }
 
    void write(char *buf, int len) {
        typedef CommCbMemFunT<Server, CommIoCbParams> Dialer;
        writer = JobCallback(33, 5, Dialer, this, Server::clientWriteDone);
        Comm::Write(clientConnection, buf, len, writer, nullptr);
    }
 
    virtual void afterClientWrite(size_t) {}
 
    bool writing() const {return writer != nullptr;}
 
// XXX: should be 'protected:' for child access only,
//      but all sorts of code likes to play directly
//      with the I/O buffers and socket.
public:
 
    void maybeMakeSpaceAvailable();
 
    // Client TCP connection details from comm layer.
    Comm::ConnectionPointer clientConnection;
 
    AnyP::ProtocolVersion transferProtocol;
 
    AnyP::PortCfgPointer port;
 
    SBuf inBuf;
 
    bool receivedFirstByte_; 
 
    Pipeline pipeline;
 
protected:
    virtual void terminateAll(const Error &, const LogTagsErrors &) = 0;
 
    bool mayBufferMoreRequestBytes() const;
 
    void doClientRead(const CommIoCbParams &io);
    void clientWriteDone(const CommIoCbParams &io);
 
    AsyncCall::Pointer reader; 
    AsyncCall::Pointer writer; 
};
 
#endif /* SQUID_SRC_SERVERS_SERVER_H */