[thirdparty/squid.git] / src / HttpHdrSc.h

/*
 * Copyright (C) 1996-2020 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_HTTPHDRSURROGATECONTROL_H
#define SQUID_HTTPHDRSURROGATECONTROL_H

#include "dlink.h"
#include "mem/forward.h"
#include "SquidString.h"

class HttpHdrScTarget;
class Packable;
class StatHist;
class StoreEntry;

typedef enum {
    SC_NO_STORE,
    SC_NO_STORE_REMOTE,
    SC_MAX_AGE,
    SC_CONTENT,
    SC_OTHER,
    SC_ENUM_END /* also used to mean "invalid" */
} http_hdr_sc_type;

/* http surogate control header field */
class HttpHdrSc
{
    MEMPROXY_CLASS(HttpHdrSc);

public:
    HttpHdrSc(const HttpHdrSc &);
    HttpHdrSc() {}
    ~HttpHdrSc();

    bool parse(const String *str);
    void packInto(Packable * p) const;
    void updateStats(StatHist *) const;
    HttpHdrScTarget * getMergedTarget (const char *ourtarget); //todo: make const?
    void setMaxAge(char const *target, int max_age);
    void addTarget(HttpHdrScTarget *t);
    void addTargetAtTail(HttpHdrScTarget *t);

    dlink_list targets;
private:
    HttpHdrScTarget * findTarget (const char *target);

};

/* Http Surrogate Control Header Field */
void httpHdrScStatDumper(StoreEntry * sentry, int idx, double val, double size, int count);
void httpHdrScInitModule (void);
HttpHdrSc *httpHdrScParseCreate(String const &);
void httpHdrScSetMaxAge(HttpHdrSc *, char const *, int);

#endif /* SQUID_HTTPHDRSURROGATECONTROL_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 1996-2020 The Squid Software Foundation and contributors
	3	*
	4	* Squid software is distributed under GPLv2+ license and includes
	5	* contributions from numerous individuals and organizations.
	6	* Please see the COPYING and CONTRIBUTORS files for details.
	7	*/
	8
	9	#ifndef SQUID_HTTPHDRSURROGATECONTROL_H
	10	#define SQUID_HTTPHDRSURROGATECONTROL_H
	11
	12	#include "dlink.h"
	13	#include "mem/forward.h"
	14	#include "SquidString.h"
	15
	16	class HttpHdrScTarget;
	17	class Packable;
	18	class StatHist;
	19	class StoreEntry;
	20
	21	typedef enum {
	22	SC_NO_STORE,
	23	SC_NO_STORE_REMOTE,
	24	SC_MAX_AGE,
	25	SC_CONTENT,
	26	SC_OTHER,
	27	SC_ENUM_END /* also used to mean "invalid" */
	28	} http_hdr_sc_type;
	29
	30	/* http surogate control header field */
	31	class HttpHdrSc
	32	{
	33	MEMPROXY_CLASS(HttpHdrSc);
	34
	35	public:
	36	HttpHdrSc(const HttpHdrSc &);
	37	HttpHdrSc() {}
	38	~HttpHdrSc();
	39
	40	bool parse(const String *str);
	41	void packInto(Packable * p) const;
	42	void updateStats(StatHist *) const;
	43	HttpHdrScTarget * getMergedTarget (const char *ourtarget); //todo: make const?
	44	void setMaxAge(char const *target, int max_age);
	45	void addTarget(HttpHdrScTarget *t);
	46	void addTargetAtTail(HttpHdrScTarget *t);
	47
	48	dlink_list targets;
	49	private:
	50	HttpHdrScTarget * findTarget (const char *target);
	51
	52	};
	53
	54	/* Http Surrogate Control Header Field */
	55	void httpHdrScStatDumper(StoreEntry * sentry, int idx, double val, double size, int count);
	56	void httpHdrScInitModule (void);
	57	HttpHdrSc *httpHdrScParseCreate(String const &);
	58	void httpHdrScSetMaxAge(HttpHdrSc , char const , int);
	59
	60	#endif /* SQUID_HTTPHDRSURROGATECONTROL_H */
	61