From: Amos Jeffries <squid3@treenet.co.nz>
Date: Mon, 22 Sep 2014 19:06:19 +0000 (-0700)
Subject: Cleanup: remove references to 'server-side'
X-Git-Tag: SQUID_3_5_0_1~46
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d5430dc8204b4254feab3368f111dd260a557c30;p=thirdparty%2Fsquid.git

Cleanup: remove references to 'server-side'
---

diff --git a/src/FwdState.cc b/src/FwdState.cc
index aea20b415e..fbca17f968 100644
--- a/src/FwdState.cc
+++ b/src/FwdState.cc
@@ -71,7 +71,7 @@ static OBJH fwdStats;
 #define MAX_FWD_STATS_IDX 9
 static int FwdReplyCodes[MAX_FWD_STATS_IDX + 1][Http::scInvalidHeader + 1];
 
-static PconnPool *fwdPconnPool = new PconnPool("server-side", NULL);
+static PconnPool *fwdPconnPool = new PconnPool("server-peers", NULL);
 CBDATA_CLASS_INIT(FwdState);
 
 #if USE_OPENSSL
@@ -447,7 +447,7 @@ FwdState::unregister(Comm::ConnectionPointer &conn)
     serverConn = NULL;
 }
 
-// Legacy method to be removed in favor of the above as soon as possible
+// \deprecated use unregister(Comm::ConnectionPointer &conn) instead
 void
 FwdState::unregister(int fd)
 {
@@ -457,7 +457,7 @@ FwdState::unregister(int fd)
 }
 
 /**
- * server-side modules call fwdComplete() when they are done
+ * FooClient modules call fwdComplete() when they are done
  * downloading an object.  Then, we either 1) re-forward the
  * request somewhere else if needed, or 2) call storeComplete()
  * to finish it off
@@ -532,7 +532,7 @@ fwdConnectDoneWrapper(const Comm::ConnectionPointer &conn, Comm::Flag status, in
  *
  * Return TRUE if the request SHOULD be retried.  This method is
  * called when the HTTP connection fails, or when the connection
- * is closed before server-side read the end of HTTP headers.
+ * is closed before reading the end of HTTP headers from the server.
  */
 bool
 FwdState::checkRetry()
@@ -1017,7 +1017,7 @@ FwdState::dispatch()
  *
  * returns TRUE if the transaction SHOULD be re-forwarded to the
  * next choice in the serverDestinations list.  This method is called when
- * server-side communication completes normally, or experiences
+ * peer communication completes normally, or experiences
  * some error after receiving the end of HTTP headers.
  */
 int
diff --git a/src/HierarchyLogEntry.h b/src/HierarchyLogEntry.h
index d443da49d9..a395295fd0 100644
--- a/src/HierarchyLogEntry.h
+++ b/src/HierarchyLogEntry.h
@@ -55,7 +55,7 @@ public:
     Http::StatusCode peer_reply_status; ///< last HTTP status code received
     timeval peer_http_request_sent; ///< last peer finished writing req
     int64_t peer_response_time; ///< last peer response delay
-    Comm::ConnectionPointer tcpServer; ///< TCP/IP level details of the last server-side connection
+    Comm::ConnectionPointer tcpServer; ///< TCP/IP level details of the last peer/server connection
     int64_t bodyBytesRead;  ///< number of body bytes received from the next hop or -1
 
 private:
diff --git a/src/adaptation/notes.dox b/src/adaptation/notes.dox
index 7a777b5da9..b01d9ff03d 100644
--- a/src/adaptation/notes.dox
+++ b/src/adaptation/notes.dox
@@ -67,8 +67,8 @@ completed or replaced.
 
 Here is a typical adaptation code sequence:
 
-- Master caller (client- or server-side): Checks ACL and starts
-  Adaptation::Iterator for the ACL-selected ServiceGroup.
+- Master caller: Checks ACL and starts Adaptation::Iterator for the
+  ACL-selected ServiceGroup.
 
 - Adaptation::Iterator: Creates ServicePlan and executes it, launching one
   service adaptation per step. Abandons the original plan and builds a dynamic
diff --git a/src/cf.data.pre b/src/cf.data.pre
index 466c94d7a5..d19d6f5070 100644
--- a/src/cf.data.pre
+++ b/src/cf.data.pre
@@ -4028,7 +4028,7 @@ DOC_START
 		[http::]<pt	Peer response time in milliseconds. The timer starts
 				when the last request byte is sent to the next hop
 				and stops when the last response byte is received.
-		[http::]<tt	Total server-side time in milliseconds. The timer 
+		[http::]<tt	Total time in milliseconds. The timer 
 				starts with the first connect request (or write I/O)
 				sent to the first selected peer. The timer stops
 				with the last I/O with the last peer.
@@ -5978,11 +5978,13 @@ TYPE: time_t
 LOC: Config.Timeout.read
 DEFAULT: 15 minutes
 DOC_START
-	The read_timeout is applied on server-side connections.  After
-	each successful read(), the timeout will be extended by this
+	Applied on peer server connections.
+
+	After each successful read(), the timeout will be extended by this
 	amount.  If no data is read again after this amount of time,
-	the request is aborted and logged with ERR_READ_TIMEOUT.  The
-	default is 15 minutes.
+	the request is aborted and logged with ERR_READ_TIMEOUT.
+
+	The default is 15 minutes.
 DOC_END
 
 NAME: write_timeout
diff --git a/src/client_side.cc b/src/client_side.cc
index 8524aad6e6..8226dd9425 100644
--- a/src/client_side.cc
+++ b/src/client_side.cc
@@ -3412,7 +3412,7 @@ ConnStateData::abortChunkedRequestBody(const err_type error)
     finishDechunkingRequest(false);
 
     // XXX: The code below works if we fail during initial request parsing,
-    // but if we fail when the server-side works already, the server may send
+    // but if we fail when the server connection is used already, the server may send
     // us its response too, causing various assertions. How to prevent that?
 #if WE_KNOW_HOW_TO_SEND_ERRORS
     ClientSocketContext::Pointer context = getCurrentContext();
diff --git a/src/client_side.h b/src/client_side.h
index c2b83725da..50a9dbef84 100644
--- a/src/client_side.h
+++ b/src/client_side.h
@@ -282,7 +282,7 @@ public:
     bool handleRequestBodyData();
 
     /// Forward future client requests using the given server connection.
-    /// Optionally, monitor pinned server connection for server-side closures.
+    /// Optionally, monitor pinned server connection for remote-end closures.
     void pinConnection(const Comm::ConnectionPointer &pinServerConn, HttpRequest *request, CachePeer *peer, bool auth, bool monitor = true);
     /// Undo pinConnection() and, optionally, close the pinned connection.
     void unpinConnection(const bool andClose);
@@ -335,7 +335,7 @@ public:
     /// Called when the initialization of peek-and-splice negotiation finidhed
     void startPeekAndSpliceDone();
     /// Called when a peek-and-splice step finished. For example after
-    /// server-side SSL certificates received and client-side SSL certificates
+    /// server SSL certificates received and fake server SSL certificates
     /// generated
     void doPeekAndSpliceStep();
     /// called by FwdState when it is done bumping the server
diff --git a/src/clients/Client.cc b/src/clients/Client.cc
index 11283ce6da..ccbac5d499 100644
--- a/src/clients/Client.cc
+++ b/src/clients/Client.cc
@@ -882,13 +882,13 @@ Client::noteAdaptationAclCheckDone(Adaptation::ServiceGroupPointer group)
     if (abortOnBadEntry("entry went bad while waiting for ICAP ACL check"))
         return;
 
-    // TODO: Should nonICAP and postICAP path check this on the server-side?
-    // That check now only happens on client-side, in processReplyAccess().
+    // TODO: Should non-ICAP and ICAP REPMOD pre-cache paths check this?
+    // That check now only happens on REQMOD pre-cache and REPMOD post-cache, in processReplyAccess().
     if (virginReply()->expectedBodyTooLarge(*request)) {
         sendBodyIsTooLargeError();
         return;
     }
-    // TODO: Should we check receivedBodyTooLarge on the server-side as well?
+    // TODO: Should we check receivedBodyTooLarge as well?
 
     if (!group) {
         debugs(11,3, HERE << "no adapation needed");
diff --git a/src/clients/Client.h b/src/clients/Client.h
index b5c9b4c8d9..40c508e9b7 100644
--- a/src/clients/Client.h
+++ b/src/clients/Client.h
@@ -23,11 +23,10 @@ class HttpMsg;
 class HttpReply;
 
 /**
- * Client is a common base for server-side classes such as
- * HttpStateData and FtpStateData. All such classes must be able to
- * consume request bodies from the client-side or ICAP producer, adapt
- * virgin responses using ICAP, and provide the client-side consumer with
- * responses.
+ * Client is a common base for classes such as HttpStateData and FtpStateData.
+ * All such classes must be able to consume request bodies from a BodyPipe
+ * or ICAP producer, adapt virgin responses using ICAP, and provide a
+ * consumer with responses.
  */
 class Client:
 #if USE_ADAPTATION
diff --git a/src/err_detail_type.h b/src/err_detail_type.h
index 2b8d0a83d4..a1cc388298 100644
--- a/src/err_detail_type.h
+++ b/src/err_detail_type.h
@@ -12,10 +12,10 @@
 typedef enum {
     ERR_DETAIL_NONE,
     ERR_DETAIL_START = 100000, // to avoid clashes with most OS error numbers
-    ERR_DETAIL_CLT_REQMOD_ABORT = ERR_DETAIL_START, // client-side detected transaction abort
-    ERR_DETAIL_CLT_REQMOD_REQ_BODY, // client-side detected REQMOD request body adaptation failure
-    ERR_DETAIL_CLT_REQMOD_RESP_BODY, // client-side detected REQMOD satisfaction reply body failure
-    ERR_DETAIL_SRV_REQMOD_REQ_BODY, // server-side detected REQMOD request body abort
+    ERR_DETAIL_CLT_REQMOD_ABORT = ERR_DETAIL_START, // client-facing code detected transaction abort
+    ERR_DETAIL_CLT_REQMOD_REQ_BODY, // client-facing code detected REQMOD request body adaptation failure
+    ERR_DETAIL_CLT_REQMOD_RESP_BODY, // client-facing code detected REQMOD satisfaction reply body failure
+    ERR_DETAIL_SRV_REQMOD_REQ_BODY, // server-facing code detected REQMOD request body abort
     ERR_DETAIL_ICAP_RESPMOD_EARLY, // RESPMOD failed w/o store entry
     ERR_DETAIL_ICAP_RESPMOD_LATE,  // RESPMOD failed with a store entry
     ERR_DETAIL_REQMOD_BLOCK, // REQMOD denied client access
diff --git a/src/http.cc b/src/http.cc
index 0e3a91434e..1d20a425a5 100644
--- a/src/http.cc
+++ b/src/http.cc
@@ -1551,7 +1551,7 @@ HttpStateData::sendComplete()
     /*
      * Set the read timeout here because it hasn't been set yet.
      * We only set the read timeout after the request has been
-     * fully written to the server-side.  If we start the timeout
+     * fully written to the peer.  If we start the timeout
      * after connection establishment, then we are likely to hit
      * the timeout for POST/PUT requests that have very large
      * request bodies.
diff --git a/src/mgr/IoAction.h b/src/mgr/IoAction.h
index d38c6fe162..d533af261c 100644
--- a/src/mgr/IoAction.h
+++ b/src/mgr/IoAction.h
@@ -17,7 +17,7 @@
 namespace Mgr
 {
 
-/// store server-side network read() size histograms
+/// store size histograms of network read() from peer server
 class IoActionData
 {
 public:
diff --git a/src/ssl/ServerBump.h b/src/ssl/ServerBump.h
index 4818f4f537..fc868e9a30 100644
--- a/src/ssl/ServerBump.h
+++ b/src/ssl/ServerBump.h
@@ -31,7 +31,7 @@ public:
     explicit ServerBump(HttpRequest *fakeRequest, StoreEntry *e = NULL, Ssl::BumpMode mode = Ssl::bumpServerFirst);
     ~ServerBump();
 
-    /// faked, minimal request; required by server-side API
+    /// faked, minimal request; required by Client API
     HttpRequest::Pointer request;
     StoreEntry *entry; ///< for receiving Squid-generated error messages
     Ssl::X509_Pointer serverCert; ///< HTTPS server certificate
diff --git a/src/store.cc b/src/store.cc
index b73cdafe07..48cde8057a 100644
--- a/src/store.cc
+++ b/src/store.cc
@@ -1067,7 +1067,7 @@ StoreEntry::complete()
 
 /*
  * Someone wants to abort this transfer.  Set the reason in the
- * request structure, call the server-side callback and mark the
+ * request structure, call the callback and mark the
  * entry for releasing
  */
 void
diff --git a/src/store_client.cc b/src/store_client.cc
index 643d2a5720..472c2f23b5 100644
--- a/src/store_client.cc
+++ b/src/store_client.cc
@@ -299,8 +299,8 @@ storeClientCopy2(StoreEntry * e, store_client * sc)
     /*
      * We used to check for ENTRY_ABORTED here.  But there were some
      * problems.  For example, we might have a slow client (or two) and
-     * the server-side is reading far ahead and swapping to disk.  Even
-     * if the server-side aborts, we want to give the client(s)
+     * the peer server is reading far ahead and swapping to disk.  Even
+     * if the peer aborts, we want to give the client(s)
      * everything we got before the abort condition occurred.
      */
     /* Warning: doCopy may indirectly free itself in callbacks,
diff --git a/src/store_swapout.cc b/src/store_swapout.cc
index 5ebbf37fca..c5648c69cc 100644
--- a/src/store_swapout.cc
+++ b/src/store_swapout.cc
@@ -233,7 +233,7 @@ StoreEntry::swapOut()
 
         /*
          * Wait until we are below the disk FD limit, only if the
-         * next server-side read won't be deferred.
+         * next read won't be deferred.
          */
         if (storeTooManyDiskFilesOpen() && !checkDeferRead(-1))
             return;