5 * SQUID Web Proxy Cache http://www.squid-cache.org/
6 * ----------------------------------------------------------
8 * Squid is the result of efforts by numerous individuals from
9 * the Internet community; see the CONTRIBUTORS file for full
10 * details. Many organizations have provided support for Squid's
11 * development; see the SPONSORS file for full details. Squid is
12 * Copyrighted (C) 2001 by the Regents of the University of
13 * California; see the COPYRIGHT file for full details. Squid
14 * incorporates software developed and/or copyrighted by other
15 * sources; see the CREDITS file for full details.
17 * This program is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation; either version 2 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program; if not, write to the Free Software
29 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
33 #ifndef SQUID_MEMOBJECT_H
34 #define SQUID_MEMOBJECT_H
36 #include "StoreIOBuffer.h"
37 #include "StoreIOState.h"
40 #include "RemovalPolicy.h"
41 #include "HttpRequestMethod.h"
43 typedef void STMCB (void *data
, StoreIOBuffer wroteBuffer
);
54 static size_t inUseCount();
55 MEMPROXY_CLASS(MemObject
);
58 MemObject(char const *, char const *);
61 void write(StoreIOBuffer
, STMCB
*, void *);
63 HttpReply
const *getReply() const;
64 void replaceHttpReply(HttpReply
*newrep
);
65 void stat (MemBuf
* mb
) const;
66 int64_t endOffset () const;
69 int64_t lowestMemReaderOffset() const;
70 bool readAheadPolicyCanRead() const;
71 void addClient(store_client
*);
72 /* XXX belongs in MemObject::swapout, once swaphdrsz is managed
75 int64_t objectBytesOnDisk() const;
76 int64_t policyLowestOffsetToKeep() const;
78 void trimUnSwappable();
79 bool isContiguous() const;
80 int mostBytesWanted(int max
) const;
81 void setNoDelay(bool const newValue
);
84 DelayId
mostBytesAllowed() const;
88 #if URL_CHECKSUM_DEBUG
90 void checkUrlChecksum() const;
93 HttpRequestMethod method
;
99 /** \todo move into .cc or .cci */
100 size_t clientCount() const {return nclients
;}
102 bool clientIsFirst(void *sc
) const {return (clients
.head
&& sc
== clients
.head
->data
);}
110 int64_t queue_offset
; /* relative to in-mem data */
111 mem_node
*memnode
; /* which node we're currently paging out */
112 StoreIOState::Pointer sio
;
117 /* Read only - this reply must be preserved by store clients */
118 /* The original reply. possibly with updated metadata. */
119 HttpRequest
*request
;
121 struct timeval start_ping
;
122 IRCB
*ping_reply_callback
;
130 RemovalPolicyNode repl
;
134 #if URL_CHECKSUM_DEBUG
139 const char *vary_headers
;
141 void delayRead(DeferredRead
const &);
147 DeferredReadManager deferredReads
;
150 MEMPROXY_CLASS_INLINE(MemObject
) /**DOCS_NOSEMI*/
152 /** global current memory removal policy */
153 extern RemovalPolicy
*mem_policy
;
155 #endif /* SQUID_MEMOBJECT_H */