为什么有些有些类的方法无法在API手册中找到？

在看ruby api文档的时候总是觉得它的API文档怪怪的，不太适应。

就说API的组织形式吧，都不太明白每个窗口的含义。比如在标准库API文档里边，右边的窗口都不同步，比如点某个类，右上角的method中并不是该类的所有方法，这点就不太使用。


最近在查一个socket编程的问题，

server = TCPServer.new(PORT)
while ( session = server.accept )

    mystr=session.recv(20)

发现使用recv方法接收指定大小的内容时会发生错误。然后在API手册中找不到这个recv方法究竟是哪个类定义的。

最后在源码socket.c中发现有这么一段：

    rb_define_method(rb_cBasicSocket, "recv", bsock_recv, -1);
    rb_define_method(rb_cBasicSocket, "recv_nonblock", bsock_recv_nonblock, -1);

我对源码不太了解，但是推测应该是basicsocket中定义的recv方法，可是遍历整个socket编程类，也没有在API文档中发现这个方法的说明。



请问究竟是我查找API手册的方法不对，没有找到位置呢，还是API手册本身就没有完全覆盖所有方法？

评论

6 楼 kaven 2008-03-11  

rdoc生成的帮助文件已经很好了，如果不够，就去
看test case，ruby就是这点好，源码和test是放在一起的。
ruby的设计是以开发人员导向的，我还没有见过比这个更加友好的工具了

5 楼 ruby_java 2008-03-10  

如果API的功能都要自己悟
哪学习曲线该多么高

4 楼 foxgst 2008-03-06  

同感，API文档似乎很简洁，便于查找，但层次不太清晰，而且用法也说得不是太明白，需要悟的地方太多...这难道是初学者才遇到的问题吗？

3 楼 ruby_java 2008-03-02  

你看到的还是
basicsocket.recv_nonblock(maxlen) => mesg
basicsocket.recv_nonblock(maxlen, flags) => mesg

这2个函数的解释

2 楼 neodoxy 2008-03-01  

ri BasicSocket#recv

---------------------------------------------- BasicSocket#recv_nonblock
     basicsocket.recv_nonblock(maxlen) => mesg
     basicsocket.recv_nonblock(maxlen, flags) => mesg
------------------------------------------------------------------------
     Receives up to _maxlen_ bytes from +socket+ using recvfrom(2) after
     O_NONBLOCK is set for the underlying file descriptor. _flags_ is
     zero or more of the +MSG_+ options. The result, _mesg_, is the data
     received.

     When recvfrom(2) returns 0, Socket#recv_nonblock returns an empty
     string as data. The meaning depends on the socket: EOF on TCP,
     empty packet on UDP, etc.

     Parameters
     *   +maxlen+ - the number of bytes to receive from the socket

     *   +flags+ - zero or more of the +MSG_+ options

     Example
          serv = TCPServer.new("127.0.0.1", 0)
          af, port, host, addr = serv.addr
          c = TCPSocket.new(addr, port)
          s = serv.accept
          c.send "aaa", 0
          IO.select([s])
          p s.recv_nonblock(10) #=> "aaa"

     Refer to Socket#recvfrom for the exceptions that may be thrown if
     the call to _recv_nonblock_ fails.

     BasicSocket#recv_nonblock may raise any error corresponding to
     recvfrom(2) failure, including Errno::EAGAIN.

     See
     *   Socket#recvfrom

------------------------------------------------------------------------------------

1 楼 ruby_java 2008-03-01  

引用

BasicSocket
表示套接字的抽象类。具体的套接字操作需要在子类加以定义。比如说internet domain stream socket的话，就要使用TCPSocket。

超类:
IO
类方法:
BasicSocket.do_not_reverse_lookup
BasicSocket.do_not_reverse_lookup = bool
若该值为真，则不会进行从地址到主机名的逆向解析。默认值是false。该设定的影响面非常大。

它会影响下列方法的运作。

BasicSocket#recv, IPSocket#recvfrom, UNIXSocket#recvfrom, Socket#recvfrom, IPSocket#addr, IPSocket#peeraddr, Socket.getaddrinfo

例:

require 'socket'

p TCPSocket.new('localhost', 'telnet').addr
TCPSocket.do_not_reverse_lookup = true
p TCPSocket.new('localhost', 'telnet').addr

=> ["AF_INET", 2253, "localhost", "127.0.0.1"]
   ["AF_INET", 2254, "127.0.0.1", "127.0.0.1"]

BasicSocket.for_fd(fd) ((<ruby 1.7 feature>))
为文件描述符fd生成一个新套接字。

ruby 1.7 特性: 该方法从 Socket类移动到该类中。这样就可以在任意套接字fd中生成相对应的套接字类了。

方法:
getpeername
获取对方的套接字信息。返回打包sockaddr结构体后得到的字符串。请参考getpeername(2)。

getsockname
获取套接字信息。返回打包sockaddr结构体后得到的字符串。请参考getsockname(2)。

getsockopt(level, optname)
获取套接字选项。请参考getsockopt(2)。将获取的选项数据打包成字符串后，返回该字符串。

recv(len[, flags])
从套接字获取数据，并以字符串形式将其返回。len规定了获取信息的最大长度。关于flags的具体细节，请参考recv(2)。flags的默认值是0。指定flags时使用的常数都被定义在Socket类中。(例: Socket::SO_LINGER)

send(mesg, flags[, to])
通过套接字发送数据。关于flags的具体细节，请参考send(2)。若套接字尚未进行连接时，则必须指定发送目的地to。返回实际发送数据的大小。

to中必须是将套接字地址结构体打包后得到的字符串。

若发送数据失败，则引发Errno::EXXX异常。

setsockopt(level, optname, optval)
设定套接字选项。请参考setsockopt(2)。

shutdown([how])
结束套接字的连接。若how为0，则只停止信息的接收；若为1则只停止信息的发送；若how为2，则停止信息的发送和接受全过程。how的缺省值就是2。请参考shutdown(2)。

这是我在网上找到的一个说明，为什么ruby本身的文档反而找不到这么详细的呢