From 61962b27a51031965cef70451d369b115868fb11 Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
Date: Thu, 10 Mar 2011 10:51:38 +0000
Subject: rdoc: 100% documentation coverage!

Of course, RDoc doesn't know quantity vs quality :)
---
 lib/raindrops/aggregate/last_data_recv.rb | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

(limited to 'lib/raindrops/aggregate/last_data_recv.rb')

diff --git a/lib/raindrops/aggregate/last_data_recv.rb b/lib/raindrops/aggregate/last_data_recv.rb
index 2935927..87cbfb9 100644
--- a/lib/raindrops/aggregate/last_data_recv.rb
+++ b/lib/raindrops/aggregate/last_data_recv.rb
@@ -1,31 +1,50 @@
 # -*- encoding: binary -*-
 require "socket"
 #
-# Used to aggregate last_data_recv times
+# This module is used to extend TCPServer and Kgio::TCPServer objects
+# and aggregate +last_data_recv+ times for all accepted clients.
+#
+# Methods wrapped include:
+# - TCPServer#accept
+# - TCPServer#accept_nonblock
+# - Kgio::TCPServer#kgio_accept
+# - Kgio::TCPServer#kgio_tryaccept
 module Raindrops::Aggregate::LastDataRecv
+  # :stopdoc:
   TCP_Info = Raindrops::TCP_Info
+  # :startdoc:
+
+  # The integer value of +last_data_recv+ is sent to this object.
   attr_accessor :raindrops_aggregate
+
   @@default_aggregate = nil
 
+  # By default, this is a Raindrops::Aggregate::PMQ object
   def self.default_aggregate
     @@default_aggregate ||= Raindrops::Aggregate::PMQ.new
   end
 
+  # assign any object that is duck-type compatible with \Aggregate here,
   def self.default_aggregate=(agg)
     @@default_aggregate = agg
   end
 
+  # automatically extends any TCPServer objects used by Unicorn
   def self.cornify!
     Unicorn::HttpServer::LISTENERS.each do |sock|
       sock.extend(self) if TCPServer === sock
     end
   end
 
+  # each extended object needs to have TCP_DEFER_ACCEPT enabled
+  # for accuracy.
   def self.extended(obj)
     obj.raindrops_aggregate = default_aggregate
     obj.setsockopt Socket::SOL_TCP, tcp_defer_accept = 9, seconds = 60
   end
 
+  # :stopdoc:
+
   def kgio_tryaccept(*args)
     count! super
   end
@@ -42,6 +61,14 @@ module Raindrops::Aggregate::LastDataRecv
     count! super
   end
 
+  # :startdoc:
+
+  # The +last_data_recv+ member of Raindrops::TCP_Info can be used to
+  # infer the time a client spent in the listen queue before it was
+  # accepted.
+  #
+  # We require TCP_DEFER_ACCEPT on the listen socket for
+  # +last_data_recv+ to be accurate
   def count!(io)
     if io
       x = TCP_Info.new(io)
-- 
cgit v1.2.3-24-ge0c7