--------------------- PatchSet 6017 Date: 2007/10/27 09:25:12 Author: amosjeffries Branch: docs Tag: (none) Log: Link more client-side comments into docs Members: src/client_side.cc:1.126.2.11->1.126.2.12 src/client_side.h:1.19.2.3->1.19.2.4 Index: squid3/src/client_side.cc =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/client_side.cc,v retrieving revision 1.126.2.11 retrieving revision 1.126.2.12 diff -u -r1.126.2.11 -r1.126.2.12 --- squid3/src/client_side.cc 15 Oct 2007 10:16:02 -0000 1.126.2.11 +++ squid3/src/client_side.cc 27 Oct 2007 09:25:12 -0000 1.126.2.12 @@ -1,5 +1,5 @@ /* - * $Id: client_side.cc,v 1.126.2.11 2007/10/15 10:16:02 amosjeffries Exp $ + * $Id: client_side.cc,v 1.126.2.12 2007/10/27 09:25:12 amosjeffries Exp $ * * DEBUG: section 33 Client-side Routines * AUTHOR: Duane Wessels @@ -195,7 +195,7 @@ return (clientStreamNode *)http->client_stream.tail->prev->data; } -/* +/** * This routine should be called to grow the inbuf and then * call comm_read(). */ @@ -341,7 +341,7 @@ clientUpdateStatHistCounters(log_type logType, int svc_time) { statHistCount(&statCounter.client_http.all_svc_time, svc_time); - /* + /** * The idea here is not to be complete, but to get service times * for only well-defined types. For example, we don't include * LOG_TCP_REFRESH_FAIL because its not really a cache hit @@ -647,7 +647,7 @@ } } -/* +/** * clientSetKeepaliveFlag() sets request->flags.proxy_keepalive. * This is the client-side persistent connection flag. We need * to set this relatively early in the request processing @@ -836,7 +836,7 @@ writeComplete(fd(), NULL, 0, COMM_OK); } -/* put terminating boundary for multiparts */ +/** put terminating boundary for multiparts */ static void clientPackTermBound(String boundary, MemBuf * mb) { @@ -844,7 +844,7 @@ debugs(33, 6, "clientPackTermBound: buf offset: " << mb->size); } -/* appends a "part" HTTP header (as in a multi-part/range reply) to the buffer */ +/** appends a "part" HTTP header (as in a multi-part/range reply) to the buffer */ static void clientPackRangeHdr(const HttpReply * rep, const HttpHdrRangeSpec * spec, String boundary, MemBuf * mb) { @@ -878,7 +878,7 @@ mb->Printf("\r\n"); } -/* +/** * extracts a "range" from *buf and appends them to mb, updating * all offsets and such. */ @@ -967,7 +967,7 @@ } } -/* returns expected content length for multi-range replies +/** returns expected content length for multi-range replies * note: assumes that httpHdrRangeCanonize has already been called * warning: assumes that HTTP headers for individual ranges at the * time of the actuall assembly will be exactly the same as @@ -1009,7 +1009,7 @@ return clen; } -/* +/** * returns true if If-Range specs match reply, false otherwise */ static int @@ -1047,7 +1047,8 @@ return 0; } -/* generates a "unique" boundary string for multipart responses +/** + * generates a "unique" boundary string for multipart responses * the caller is responsible for cleaning the string */ String ClientHttpRequest::rangeBoundaryStr() const @@ -1061,7 +1062,7 @@ return b; } -/* adds appropriate Range headers if needed */ +/** adds appropriate Range headers if needed */ void ClientSocketContext::buildRangeHeader(HttpReply * rep) { @@ -1218,7 +1219,7 @@ delete mb; } -/* +/** * Write a chunk of data to a client socket. If the reply is present, * send the reply headers down the wire too, and clean them up when * finished. @@ -1271,7 +1272,8 @@ PROF_stop(clientSocketRecipient); } -/* Called when a downstream node is no longer interested in +/** + * Called when a downstream node is no longer interested in * our data. As we are a terminal node, this means on aborts * only */ @@ -1540,7 +1542,8 @@ return STREAM_NONE; } -/* A write has just completed to the client, or we have just realised there is +/** + * A write has just completed to the client, or we have just realised there is * no more data to send. */ void @@ -1674,7 +1677,7 @@ return result; } -/* +/** * 'end' defaults to NULL for backwards compatibility * remove default value if we ever get rid of NULL-terminated * request buffers. @@ -1817,7 +1820,7 @@ } } -/* +/** * parseHttpRequest() * * Returns @@ -2333,7 +2336,7 @@ return result; } -/* +/** * bodySizeLeft * * Report on the number of bytes of body content that we @@ -2350,7 +2353,7 @@ return 0; } -/* +/** * Attempt to parse one or more requests from the input buffer. * If a request is successfully parsed, even if the next request * is only partially parsed, it will return TRUE. @@ -2526,7 +2529,9 @@ clientAfterReadingRequests(fd, conn, do_next_read); } -// called when new request data has been read from the socket +/** + * called when new request data has been read from the socket + */ void ConnStateData::handleReadData(char *buf, size_t size) { @@ -2544,8 +2549,10 @@ handleRequestBodyData(); } -// called when new request body data has been buffered in in.buf -// may close the connection if we were closing and piped everything out +/** + * called when new request body data has been buffered in in.buf + * may close the connection if we were closing and piped everything out + */ void ConnStateData::handleRequestBodyData() { @@ -2588,7 +2595,7 @@ startClosing("body consumer aborted"); } -/* general lifetime handler for HTTP requests */ +/** general lifetime handler for HTTP requests */ static void requestTimeout(int fd, void *data) { @@ -2736,7 +2743,7 @@ return result; } -/* Handle a new connection on HTTP socket. */ +/** Handle a new connection on HTTP socket. */ void httpAccept(int sock, int newfd, ConnectionDetail *details, comm_err_t flag, int xerrno, void *data) @@ -2798,7 +2805,7 @@ #if USE_SSL -/* negotiate an SSL connection */ +/** negotiate an SSL connection */ static void clientNegotiateSSL(int fd, void *data) { @@ -2917,7 +2924,7 @@ conn->readSomeData(); } -/* handle a new HTTPS connection */ +/** handle a new HTTPS connection */ static void httpsAccept(int sock, int newfd, ConnectionDetail *details, comm_err_t flag, int xerrno, void *data) @@ -3242,8 +3249,10 @@ return closing_; } -// Called by ClientSocketContext to give the connection a chance to read -// the entire body before closing the socket. +/** + * Called by ClientSocketContext to give the connection a chance to read + * the entire body before closing the socket. + */ void ConnStateData::startClosing(const char *reason) { Index: squid3/src/client_side.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/client_side.h,v retrieving revision 1.19.2.3 retrieving revision 1.19.2.4 diff -u -r1.19.2.3 -r1.19.2.4 --- squid3/src/client_side.h 5 Oct 2007 05:27:48 -0000 1.19.2.3 +++ squid3/src/client_side.h 27 Oct 2007 09:25:13 -0000 1.19.2.4 @@ -1,6 +1,6 @@ /* - * $Id: client_side.h,v 1.19.2.3 2007/10/05 05:27:48 amosjeffries Exp $ + * $Id: client_side.h,v 1.19.2.4 2007/10/27 09:25:13 amosjeffries Exp $ * * * SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -48,7 +48,6 @@ class AuthUserRequest; template - class Range; class ClientSocketContext : public RefCountable @@ -127,7 +126,7 @@ }; -/* A connection to a socket */ +/** A connection to a socket */ class ConnStateData : public BodyProducer, public RefCountable { @@ -163,17 +162,19 @@ int64_t bodySizeLeft(); - /* + /** * Is this connection based authentication? if so what type it * is. */ auth_type_t auth_type; - /* + + /** * note this is ONLY connection based because NTLM is against HTTP spec. * the user details for connection based authentication */ AuthUserRequest *auth_user_request; - /* + + /** * used by the owner of the connection, opaque otherwise * TODO: generalise the connection owner concept. */