Spec-Zone.ru › Ruby 3.3

класс UNIXServer

Родитель:
UNIXSocket

UNIXServer представляет сокет сервера потокового типа доменного типа UNIX.

Публичные методы класса

new(path) → unixserver Показать исходный код
static VALUE
unix_svr_init(VALUE sock, VALUE path)
{
    return rsock_init_unixsock(sock, path, 1);
}

Создаёт новый сокет сервера UNIX, привязанный к path.

require 'socket'

serv = UNIXServer.new("/tmp/sock")
s = serv.accept
p s.read

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

accept → unixsocket Показать исходный код
static VALUE
unix_accept(VALUE server)
{
    struct sockaddr_un buffer;
    socklen_t length = sizeof(buffer);

    return rsock_s_accept(rb_cUNIXSocket, server, (struct sockaddr*)&buffer, &length);
}

Принимает входящее подключение. Возвращает новый объект UNIXSocket.

UNIXServer.open("/tmp/sock") {|serv|
  UNIXSocket.open("/tmp/sock") {|c|
    s = serv.accept
    s.puts "hi"
    s.close
    p c.read #=> "hi\n"
  }
}
accept_nonblock([options]) → unixsocket Показать исходный код
# File ext/socket/lib/socket.rb, line 1360
def accept_nonblock(exception: true)
  __accept_nonblock(exception)
end

Принимает входящее подключение, используя accept(2) после установки O_NONBLOCK для базового дескриптора файла. Возвращает принятый UNIXSocket для входящего подключения.

Пример

require 'socket'
serv = UNIXServer.new("/tmp/sock")
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 для исключений, которые могут быть возбуждены, если вызов UNIXServer#accept_nonblock завершается неудачно.

UNIXServer#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.

См. также

  • UNIXServer#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 - socket не привязан вызовом bind.

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

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

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

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

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

См. также

  • Руководства по listen в unix-подобных системах

  • Функция listen в справочнике по функциям Microsoft Winsock

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

    return rsock_s_accept(0, server, (struct sockaddr*)&buffer, &length);
}

Принимает новое подключение. Возвращает новый дескриптор файла, который является целым числом.

UNIXServer.open("/tmp/sock") {|serv|
  UNIXSocket.open("/tmp/sock") {|c|
    fd = serv.sysaccept
    s = IO.new(fd)
    s.puts "hi"
    s.close
    p c.read #=> "hi\n"
  }
}

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