Spec-Zone.ru › Ruby 3.1

класс 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, Qnil, Qnil);
}

Создаёт новый сокет сервера, привязанный к порту 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 server)
{
    union_sockaddr buffer;
    socklen_t length = sizeof(buffer);

    return rsock_s_accept(rb_cTCPSocket, server, &buffer.addr, &length);
}

Принимает входящее подключение. Возвращает новый объект 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 1313
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 это будет работать, так как новый sockaddr создаётся по адресу ADDR_ANY для произвольного номера порта, передаваемого ядром. Это не сработает в Windows, так как Windows требует, чтобы сокет socket был привязан с помощью вызова bind перед вызовом listen.

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

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

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

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

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

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

  • Errno::EOPNOTSUPP - протокол сокета не поддерживает 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 - сокет не был привязан с помощью вызова bind.

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

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

  • Errno::ENOBUFS - нет доступного буферного пространства

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

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

См. также

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

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

sysaccept → file_descriptor Показать исходный код
static VALUE
tcp_sysaccept(VALUE server)
{
    union_sockaddr buffer;
    socklen_t length = sizeof(buffer);

    return rsock_s_accept(0, server, &buffer.addr, &length);
}

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

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–2022 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

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