在线文档教程
Ruby 2.4

TCPServer

TCPServer类

Parent:TCPSocket

TCPServer代表一个TCP / IP服务器套接字。

一个简单的TCP服务器可能如下所示:

require 'socket' server = TCPServer.new 2000 # Server bind to port 2000 loop do client = server.accept # Wait for a client to connect client.puts "Hello !" client.puts "Time is #{Time.now}" client.close end

更有用的服务器(服务多个客户端):

require 'socket' server = TCPServer.new 2000 loop do Thread.start(server.accept) do |client| client.puts "Hello !" client.puts "Time is #{Time.now}" client.close end end

公共类方法

new(hostname, port) → tcpserver Show source

创建绑定到端口的新服务器套接字。

如果给出主机名,套接字直接就能绑定到它。

serv = TCPServer.new("127.0.0.1", 28561) s = serv.accept s.puts Time.now s.close

在内部,:: new调用getaddrinfo()函数来获取地址。如果getaddrinfo()返回多个地址,则:: new尝试为每个地址创建一个服务器套接字并返回第一个成功的套接字。

static VALUE tcp_svr_init(int argc, VALUE *argv, VALUE sock) { VALUE hostname, port; rb_scan_args(argc, argv, "011", &hostname, &port return rsock_init_inetsock(sock, hostname, port, Qnil, Qnil, INET_SERVER }

公共实例方法

accept → tcpsocket Show source

接受传入的连接。它返回一个新的TCPSocket对象。

TCPServer.open("127.0.0.1", 14641) {|serv| s = serv.accept s.puts Time.now s.close }

static VALUE tcp_accept(VALUE sock) { rb_io_t *fptr; union_sockaddr from; socklen_t fromlen; GetOpenFile(sock, fptr fromlen = (socklen_t)sizeof(from return rsock_s_accept(rb_cTCPSocket, fptr->fd, &from.addr, &fromlen }

accept_nonblock(options) → tcpsocket Show source

在为基础文件描述符设置O_NONBLOCK后,使用accept(2)接受传入连接。它为传入的连接返回一个可接受的TCPSocket。

require 'socket' serv = TCPServer.new(2202) begin # emulate blocking accept sock = serv.accept_nonblock rescue IO::WaitReadable, Errno::EINTR IO.select([serv]) retry end # sock is an accepted socket.

如果调用#accept_nonblock失败,请参阅Socket#accept以了解可能会抛出的异常。

#accept_nonblock可能引发与accept(2)失败相对应的任何错误,包括Errno :: EWOULDBLOCK。

如果这个异常是Errno :: EWOULDBLOCK,Errno :: EAGAIN,Errno :: ECONNABORTED,Errno :: EPROTO,则它由IO :: WaitReadable扩展。所以IO :: WaitReadable可以用来解救重试accept_nonblock的异常。

通过指定关键字参数异常false,你可以指出#accept_nonblock应该不会引发IO :: WaitReadable异常,但返回的符号:wait_readable来代替。

参阅

  • #accept

  • Socket#accept

# File ext/socket/lib/socket.rb, line 1296 def accept_nonblock(exception: true) __accept_nonblock(exception) end

listen( int ) → 0 Show source

侦听连接,使用指定的int作为积压。 只有在套接字类型为SOCK_STREAM或SOCK_SEQPACKET的情况下才能调用侦听。

参数

  • backlog - 等待连接队列的最大长度。

  • Errno :: EBADF - 套接字参数不是有效的文件描述符

  • Errno :: EDESTADDRREQ - 套接字未绑定到本地地址,且协议不支持侦听未绑定的套接字

  • Errno :: EINVAL - 套接字已经连接

  • Errno :: ENOTSOCK - 套接字参数不引用套接字

  • Errno :: EOPNOTSUPP - 套接字协议不支持listen

  • Errno :: EACCES - 调用过程没有适当的权限

  • Errno :: EINVAL - 套接字 已关闭

  • Errno :: ENOBUFS - 系统中可用资源不足以完成callWindows异常在Windows系统中,如果侦听 呼叫失败,可能会引发以下系统异常:

  • Errno :: ENETDOWN - 网络已关闭

  • Errno :: EADDRINUSE - 套接字的本地地址已被使用。这通常发生在执行绑定期间,但如果绑定 调用是部分通配符地址(涉及ADDR_ANY),并且在调用时需要提交特定地址以便侦听

  • Errno :: EINPROGRESS - 正在进行Windows套接字1.1调用,或者服务提供者仍在处理回调函数

  • Errno :: EINVAL - socket尚未绑定调用绑定

  • Errno :: EISCONN - socket已连接

  • Errno :: EMFILE - 没有套接字描述符处于可用状态

  • Errno :: ENOBUFS - 没有可用的缓冲空间

  • Errno :: ENOTSOC - socket不是套接字

  • Errno :: EOPNOTSUPP - 引用的socket不是支持listen方法的类型

参阅

  • 在基于Unix的系统上收听手册页面

  • 在Microsoft的Winsock函数参考中的监听函数

VALUE rsock_sock_listen(VALUE sock, VALUE log) { rb_io_t *fptr; int backlog; backlog = NUM2INT(log GetOpenFile(sock, fptr if (listen(fptr->fd, backlog) < 0) rb_sys_fail("listen(2)" return INT2FIX(0 }

sysaccept → file_descriptor Show source

返回接受连接的文件描述符。

TCPServer.open("127.0.0.1", 28561) {|serv| fd = serv.sysaccept s = IO.for_fd(fd) s.puts Time.now s.close }

static VALUE tcp_sysaccept(VALUE sock) { rb_io_t *fptr; union_sockaddr from; socklen_t fromlen; GetOpenFile(sock, fptr fromlen = (socklen_t)sizeof(from return rsock_s_accept(0, fptr->fd, &from.addr, &fromlen }