ruby-changes:10664
From: akr <ko1@a...>
Date: Wed, 11 Feb 2009 13:30:04 +0900 (JST)
Subject: [ruby-changes:10664] Ruby:r22226 (trunk): update rdoc.
akr 2009-02-11 13:29:12 +0900 (Wed, 11 Feb 2009) New Revision: 22226 http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=22226 Log: update rdoc. Modified files: trunk/ext/socket/option.c Index: ext/socket/option.c =================================================================== --- ext/socket/option.c (revision 22225) +++ ext/socket/option.c (revision 22226) @@ -34,6 +34,16 @@ } } +/* + * call-seq: + * Socket::Option.new(family, level, optname, data) => sockopt + * + * Returns a new Socket::Option object. + * + * sockopt = Socket::Option.new(:INET, :SOCKET, :KEEPALIVE, [1].pack("i")) + * p sockopt #=> #<Socket::Option: INET SOCKET KEEPALIVE 1> + * + */ static VALUE sockopt_initialize(VALUE self, VALUE vfamily, VALUE vlevel, VALUE voptname, VALUE data) { @@ -333,6 +343,17 @@ } #endif + +/* + * call-seq: + * sockopt.inspect => string + * + * Returns a string which shows sockopt in human-readable form. + * + * p Socket::Option.new(:INET, :SOCKET, :KEEPALIVE, [1].pack("i")).inspect + * #=> "#<Socket::Option: INET SOCKET KEEPALIVE 1>" + * + */ static VALUE sockopt_inspect(VALUE self) { @@ -522,6 +543,16 @@ return ret; } +/* + * call-seq: + * sockopt.unpack(template) => array + * + * Calls String#unpack on sockopt.data. + * + * sockopt = Socket::Option.new(:INET, :SOCKET, :KEEPALIVE, [1].pack("i")) + * p sockopt.unpack("i") #=> [1] + * p sockopt.data.unpack("i") #=> [1] + */ static VALUE sockopt_unpack(VALUE self, VALUE template) { -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/