класс TCPServer
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
Публичные методы класса
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
Внутренне, ::new вызывает функцию getaddrinfo() для получения адресов. Если getaddrinfo() возвращает несколько адресов, ::new пытается создать серверный сокет для каждого адреса и возвращает первый успешный.
Публичные методы экземпляра
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
}
static VALUE
tcp_accept_nonblock(VALUE sock)
{
rb_io_t *fptr;
union_sockaddr from;
socklen_t fromlen;
GetOpenFile(sock, fptr);
fromlen = (socklen_t)sizeof(from);
return rsock_s_accept_nonblock(rb_cTCPSocket, fptr, &from.addr, &fromlen);
} Принимает входящее соединение, используя 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 для исключений, которые могут быть выброшены, если вызов #accept_nonblock завершится неудачно.
#accept_nonblock может генерировать любое исключение, соответствующее неудаче accept(2), включая Errno::EWOULDBLOCK.
Если исключение — Errno::EWOULDBLOCK, Errno::AGAIN, Errno::ECONNABORTED, Errno::EPROTO, оно дополняется IO::WaitReadable. Таким образом, IO::WaitReadable можно использовать для перехвата исключений и повторной попытки accept_nonblock.
См. также
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 — socket не привязан к локальному адресу, и протокол не поддерживает прослушивание на несвязанном сокете
-
Errno::EINVAL — socket уже подключён
-
Errno::ENOTSOCK — аргумент socket не ссылается на сокет
-
Errno::EOPNOTSUPP — протокол socket не поддерживает прослушивание
-
Errno::EACCES — у вызывающего процесса нет соответствующих привилегий
-
Errno::EINVAL — socket был закрыт
-
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 Майкрософт
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.