RequestMethod.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_REQUESTMETHOD_H
#define SQUID_SRC_HTTP_REQUESTMETHOD_H
 
#include "http/forward.h"
#include "http/MethodType.h"
#include "sbuf/SBuf.h"
 
class SquidConfig;
 
#include <iosfwd>
 
class HttpRequestMethod
{
public:
    HttpRequestMethod() : theMethod(Http::METHOD_NONE), theImage() {}
    HttpRequestMethod(Http::MethodType const aMethod) : theMethod(aMethod), theImage() {}
    explicit HttpRequestMethod(const SBuf &);
 
    void HttpRequestMethodXXX(char const *); // deprecated old c-string to SBuf converter.
 
    HttpRequestMethod & operator = (Http::MethodType const aMethod) {
        theMethod = aMethod;
        theImage.clear();
        return *this;
    }
 
    explicit operator bool() const { return theMethod != Http::METHOD_NONE; }
 
    bool operator == (Http::MethodType const & aMethod) const { return theMethod == aMethod; }
    bool operator == (HttpRequestMethod const & aMethod) const {
        return theMethod == aMethod.theMethod &&
               (theMethod != Http::METHOD_OTHER || theImage == aMethod.theImage);
    }
 
    bool operator != (Http::MethodType const & aMethod) const { return theMethod != aMethod; }
    bool operator != (HttpRequestMethod const & aMethod) const {
        return !operator==(aMethod);
    }
 
    HttpRequestMethod& operator++() {
        // TODO: when this operator is used in more than one place,
        // replace it with HttpRequestMethods::Iterator API
        // XXX: this interface can create Http::METHOD_OTHER without an image
        assert(theMethod < Http::METHOD_ENUM_END);
        theMethod = (Http::MethodType)(1 + (int)theMethod);
        return *this;
    }
 
    Http::MethodType id() const { return theMethod; }
 
    const SBuf &image() const;
 
    bool isHttpSafe() const;
 
    bool isIdempotent() const;
 
    bool respMaybeCacheable() const;
 
    bool shouldInvalidate() const;
 
    /* Whether this method invalidates existing cached entries.
     * Kept for backward-compatibility. This is the old 2.x-3.2 invalidation behaviour.
     *
     * NOTE:
     *    purgesOthers differs from shouldInvalidate() in that purgesOthers() returns
     *    true on any methods the MAY invalidate (Squid opts to do so).
     *    shouldInvalidate() only returns true on methods which SHOULD invalidate.
     */
    bool purgesOthers() const;
 
private:
    Http::MethodType theMethod; 
    SBuf theImage;     
};
 
inline std::ostream &
operator << (std::ostream &os, HttpRequestMethod const &method)
{
    os << method.image();
    return os;
}
 
#endif /* SQUID_SRC_HTTP_REQUESTMETHOD_H */