ruby-changes:19561
From: drbrain <ko1@a...>
Date: Tue, 17 May 2011 07:09:44 +0900 (JST)
Subject: [ruby-changes:19561] drbrain:r31602 (trunk): * lib/net/pop.rb: Improve documentation. Patch by Vincent Batts.
drbrain 2011-05-17 07:09:23 +0900 (Tue, 17 May 2011) New Revision: 31602 http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=31602 Log: * lib/net/pop.rb: Improve documentation. Patch by Vincent Batts. [Ruby 1.9 - Bug #4711] * lib/net/telnet.rb: ditto Modified files: trunk/ChangeLog trunk/lib/net/pop.rb trunk/lib/net/telnet.rb Index: ChangeLog =================================================================== --- ChangeLog (revision 31601) +++ ChangeLog (revision 31602) @@ -1,3 +1,9 @@ +Tue May 17 07:09:01 2011 Eric Hodel <drbrain@s...> + + * lib/net/pop.rb: Improve documentation. Patch by Vincent Batts. + [Ruby 1.9 - Bug #4711] + * lib/net/telnet.rb: ditto + Tue May 17 07:00:41 2011 Eric Hodel <drbrain@s...> * lib/net/http.rb: Fix nodoc for Net::HTTP::version_1_1?. Patch by Index: lib/net/pop.rb =================================================================== --- lib/net/pop.rb (revision 31601) +++ lib/net/pop.rb (revision 31602) @@ -196,12 +196,14 @@ # class POP3 < Protocol + # svn revision of this library Revision = %q$Revision$.split[1] # # Class Parameters # + # returns the port for POP3 def POP3.default_port default_pop3_port() end @@ -333,6 +335,7 @@ @ssl_params = create_ssl_params(*args) end + # Constructs proper parameters from arguments def POP3.create_ssl_params(verify_or_params = {}, certs = nil) begin params = verify_or_params.to_hash @@ -355,18 +358,24 @@ @ssl_params = nil end + # returns the SSL Parameters + # + # see also POP3.enable_ssl def POP3.ssl_params return @ssl_params end + # returns +true+ if POP3.ssl_params is set def POP3.use_ssl? return !@ssl_params.nil? end + # returns whether verify_mode is enable from POP3.ssl_params def POP3.verify return @ssl_params[:verify_mode] end + # returns the :ca_file or :ca_path from POP3.ssh_params def POP3.certs return @ssl_params[:ca_file] || @ssl_params[:ca_path] end @@ -452,6 +461,7 @@ end end + # Disable SSL for all new instances. def disable_ssl @ssl_params = nil end @@ -530,6 +540,7 @@ end end + # internal method for Net::POP3.start def do_start(account, password) s = timeout(@open_timeout) { TCPSocket.open(@address, port) } if use_ssl? @@ -565,6 +576,7 @@ end private :do_start + # Does nothing def on_connect end private :on_connect @@ -575,6 +587,11 @@ do_finish end + # nil's out the: + # - mails + # - number counter for mails + # - number counter for bytes + # - quits the current command, if any def do_finish @mails = nil @n_mails = nil @@ -588,6 +605,9 @@ end private :do_finish + # Returns the current command. + # + # Raises IOError if there is no active socket def command raise IOError, 'POP session not opened yet' \ if not @socket or @socket.closed? @@ -687,6 +707,7 @@ @mails.each {|m| m.uid = uidl[m.number] } end + # deguging output for +msg+ def logging(msg) @debug_output << msg + "\n" if @debug_output end Index: lib/net/telnet.rb =================================================================== --- lib/net/telnet.rb (revision 31601) +++ lib/net/telnet.rb (revision 31602) @@ -754,6 +754,7 @@ line end + # Closes the connection def close @sock.close end -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/