BandwidthBucket.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_BANDWIDTHBUCKET_H
#define SQUID_SRC_BANDWIDTHBUCKET_H
 
#if USE_DELAY_POOLS
 
#include "comm/IoCallback.h"
 
class fde;
 
class BandwidthBucket
{
public:
    BandwidthBucket(const int speed, const int initialLevelPercent, const double sizeLimit);
    virtual ~BandwidthBucket() {}
 
    static BandwidthBucket *SelectBucket(fde *f);
 
    virtual int quota() = 0;
    virtual bool applyQuota(int &nleft, Comm::IoCallback *state);
    virtual void scheduleWrite(Comm::IoCallback *state) = 0;
    virtual void onFdClosed() { selectWaiting = false; }
    virtual void reduceBucket(const int len);
    bool noLimit() const { return writeSpeedLimit < 0; }
 
protected:
    void refillBucket();
 
public:
    double bucketLevel; 
    bool selectWaiting; 
 
protected:
    double prevTime; 
    double writeSpeedLimit; 
    double bucketSizeLimit; 
};
 
#endif /* USE_DELAY_POOLS */
 
#endif /* SQUID_SRC_BANDWIDTHBUCKET_H */