Stream.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_HTTP_STREAM_H
#define SQUID_SRC_HTTP_STREAM_H
 
#include "clientStreamForward.h"
#include "comm/forward.h"
#include "debug/Stream.h"
#include "error/Error.h"
#include "http/forward.h"
#include "log/forward.h"
#include "mem/forward.h"
#include "servers/forward.h"
#include "StoreIOBuffer.h"
#if USE_DELAY_POOLS
#include "MessageBucket.h"
#endif
 
namespace Http
{
 
class Stream : public RefCountable
{
    MEMPROXY_CLASS(Stream);
 
public:
    Stream(const Comm::ConnectionPointer &aConn, ClientHttpRequest *aReq);
    ~Stream() override;
 
    void registerWithConn();
 
    bool connRegistered() const {return connRegistered_;};
 
    bool startOfOutput() const;
 
    void writeComplete(size_t size);
 
    void pullData();
 
    bool multipartRangeRequest() const;
 
    int64_t getNextRangeOffset() const;
    bool canPackMoreRanges() const;
    size_t lengthToSend(Range<int64_t> const &available) const;
 
    clientStream_status_t socketState();
 
    void sendStartOfMessage(HttpReply *, StoreIOBuffer bodyData);
    void sendBody(StoreIOBuffer bodyData);
    void noteSentBodyBytes(size_t);
 
    void buildRangeHeader(HttpReply *);
 
    clientStreamNode * getTail() const;
    clientStreamNode * getClientReplyContext() const;
 
    ConnStateData *getConn() const;
 
    void noteIoError(const Error &, const LogTagsErrors &);
 
    void finished();
 
    void initiateClose(const char *reason);
 
    void deferRecipientForLater(clientStreamNode *, HttpReply *, StoreIOBuffer receivedData);
 
public: // HTTP/1.x state data
 
    Comm::ConnectionPointer clientConnection; 
    ClientHttpRequest *http;    /* we pretend to own that Job */
    HttpReply *reply;
    char reqbuf[HTTP_REQBUF_SZ];
    struct {
        unsigned deferred:1; 
        unsigned parsed_ok:1; 
    } flags;
 
    bool mayUseConnection() const {return mayUseConnection_;}
 
    void mayUseConnection(bool aBool) {
        mayUseConnection_ = aBool;
        debugs(33, 3, "This " << this << " marked " << aBool);
    }
 
    class DeferredParams
    {
 
    public:
        clientStreamNode *node;
        HttpReply *rep;
        StoreIOBuffer queuedBuffer;
    };
 
    DeferredParams deferredparams;
    int64_t writtenToSocket;
 
private:
    void prepareReply(HttpReply *);
    void packChunk(const StoreIOBuffer &bodyData, MemBuf &);
    void packRange(StoreIOBuffer const &, MemBuf *);
    void doClose();
 
    bool mayUseConnection_; /* This request may use the connection. Don't read anymore requests for now */
    bool connRegistered_;
#if USE_DELAY_POOLS
    MessageBucket::Pointer writeQuotaHandler; 
#endif
};
 
} // namespace Http
 
#endif /* SQUID_SRC_HTTP_STREAM_H */