Spec-Zone.ru › Ruby 2.6

класс TCPServer

Родитель:
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 Показать исходный код
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);
}

Создает новый сокет сервера, привязанный к порту port.

Если указан hostname, сокет привязывается к нему.

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

Внутренне, TCPServer.new вызывает функцию getaddrinfo() для получения адресов. Если getaddrinfo() возвращает несколько адресов, TCPServer.new пытается создать сокет сервера для каждого адреса и возвращает первый успешно созданный.

Публичные методы экземпляра

accept → tcpsocket Показать исходный код
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);
}

Принимает входящее соединение. Возвращает новый объект TCPSocket.

TCPServer.open("127.0.0.1", 14641) {|serv|
  s = serv.accept
  s.puts Time.now
  s.close
}
accept_nonblock([options]) → tcpsocket Показать исходный код
# File ext/socket/lib/socket.rb, line 1312
def accept_nonblock(exception: true)
  __accept_nonblock(exception)
end

Принимает входящее соединение с использованием accept(2) после установки O_NONBLOCK для базового дескриптора файла. Возвращает принятый сокет 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.

Обратитесь к Socket#accept для получения информации об исключениях, которые могут быть выброшены, если вызов TCPServer#accept_nonblock завершился неудачно.

TCPServer#accept_nonblock может вызвать любое исключение, соответствующее ошибке accept(2), включая Errno::EWOULDBLOCK.

Если исключение Errno::EWOULDBLOCK, Errno::EAGAIN, Errno::ECONNABORTED, Errno::EPROTO, оно расширяется с помощью IO::WaitReadable. Поэтому IO::WaitReadable можно использовать для перехвата исключений для повторной попытки accept_nonblock.

Указав ключевой аргумент exception в false, вы можете указать, что accept_nonblock не должен вызывать исключение IO::WaitReadable, а вместо этого вернуть символ :wait_readable.

См. также

  • TCPServer#accept

  • Socket#accept

listen( int ) → 0 Показать исходный код
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);
}

Прослушивает подключения, используя указанный int в качестве размера очереди ожидающих подключений. Вызов listen применяется только если socket имеет тип SOCK_STREAM или SOCK_SEQPACKET.

Параметр

  • backlog - максимальная длина очереди ожидающих подключений.

Пример 1

require 'socket'
include Socket::Constants
socket = Socket.new( AF_INET, SOCK_STREAM, 0 )
sockaddr = Socket.pack_sockaddr_in( 2200, 'localhost' )
socket.bind( sockaddr )
socket.listen( 5 )

Пример 2 (прослушивание на произвольном порту, только для систем на основе Unix):

require 'socket'
include Socket::Constants
socket = Socket.new( AF_INET, SOCK_STREAM, 0 )
socket.listen( 1 )

Исключения для систем на основе Unix

В системах на основе Unix это сработает, потому что на адрес ADDR_ANY для произвольного номера порта создается новая структура sockaddr, которая передается ядром. Это не сработает в Windows, потому что Windows требует, чтобы socket был привязан вызовом bind перед вызовом listen.

Если значение backlog превышает максимальную длину очереди, зависящую от реализации, будет использоваться максимальная длина очереди реализации.

В системах на основе Unix могут быть выброшены следующие системные исключения, если вызов listen завершился неудачно:

  • Errno::EBADF - аргумент socket не является допустимым дескриптором файла

  • Errno::EDESTADDRREQ - сокет не привязан к локальному адресу, а протокол не поддерживает прослушивание на незавязанном сокете

  • Errno::EINVAL - сокет уже подключен

  • Errno::ENOTSOCK - аргумент socket не ссылается на сокет

  • Errno::EOPNOTSUPP - протокол socket не поддерживает listen

  • Errno::EACCES - у вызывающего процесса нет соответствующих привилегий

  • Errno::EINVAL - сокет был закрыт

  • Errno::ENOBUFS - в системе недостаточно ресурсов для выполнения вызова

Исключения для Windows

В системах Windows могут быть выброшены следующие системные исключения, если вызов listen завершился неудачно:

  • Errno::ENETDOWN - сеть не активна

  • Errno::EADDRINUSE - локальный адрес сокета уже используется. Это обычно происходит во время выполнения bind, но может задержаться, если вызов bind был к частично подстановочному адресу (включая ADDR_ANY) и если конкретный адрес должен быть подтвержден в момент вызова listen

  • Errno::EINPROGRESS - вызов Windows Sockets 1.1 выполняется или поставщик услуг все еще обрабатывает функцию обратного вызова

  • Errno::EINVAL - socket не был привязан вызовом bind.

  • Errno::EISCONN - socket уже подключен

  • Errno::EMFILE - больше нет дескрипторов сокетов

  • Errno::ENOBUFS - нет места в буфере

  • Errno::ENOTSOC - socket не является сокетом

  • Errno::EOPNOTSUPP - указанный socket не является типом, который поддерживает метод listen

См. также

  • Страницы руководства listen в системах на основе Unix

  • Функция listen в справочнике функций Winsock Майкрософт

sysaccept → file_descriptor Показать исходный код
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);
}

Возвращает дескриптор файла принятого соединения.

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

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API