类 BasicSocket

BasicSocket 是所有 Socket 类的超类。

公共类方法

do_not_reverse_lookup → true 或 false 点击切换源代码

获取全局 do_not_reverse_lookup 标志。

BasicSocket.do_not_reverse_lookup  #=> false

static VALUE
bsock_do_not_rev_lookup(VALUE _)
{
    return rsock_do_not_reverse_lookup?Qtrue:Qfalse;
}
do_not_reverse_lookup = bool 点击切换源代码

设置全局 do_not_reverse_lookup 标志。

该标志用于每个套接字的 do_not_reverse_lookup 的初始值。

s1 = TCPSocket.new("localhost", 80)
p s1.do_not_reverse_lookup                 #=> true
BasicSocket.do_not_reverse_lookup = false
s2 = TCPSocket.new("localhost", 80)
p s2.do_not_reverse_lookup                 #=> false
p s1.do_not_reverse_lookup                 #=> true

static VALUE
bsock_do_not_rev_lookup_set(VALUE self, VALUE val)
{
    rsock_do_not_reverse_lookup = RTEST(val);
    return val;
}
for_fd(fd) → basicsocket 点击切换源代码

返回一个包含文件描述符 fd 的套接字对象。

# If invoked by inetd, STDIN/STDOUT/STDERR is a socket.
STDIN_SOCK = Socket.for_fd(STDIN.fileno)
p STDIN_SOCK.remote_address

static VALUE
bsock_s_for_fd(VALUE klass, VALUE _descriptor)
{
    rb_io_t *fptr;

    int descriptor = RB_NUM2INT(_descriptor);
    rsock_validate_descriptor(descriptor);

    VALUE sock = rsock_init_sock(rb_obj_alloc(klass), descriptor);

    GetOpenFile(sock, fptr);

    return sock;
}

公共实例方法

close_read → nil 点击切换源代码

使用 shutdown 系统调用禁止进一步读取。

s1, s2 = UNIXSocket.pair
s1.close_read
s2.puts #=> Broken pipe (Errno::EPIPE)

static VALUE
bsock_close_read(VALUE sock)
{
    rb_io_t *fptr;

    GetOpenFile(sock, fptr);
    shutdown(fptr->fd, 0);
    if (!(fptr->mode & FMODE_WRITABLE)) {
        return rb_io_close(sock);
    }
    fptr->mode &= ~FMODE_READABLE;

    return Qnil;
}
close_write → nil 点击切换源代码

使用 shutdown 系统调用禁止进一步写入。

UNIXSocket.pair {|s1, s2|
  s1.print "ping"
  s1.close_write
  p s2.read        #=> "ping"
  s2.print "pong"
  s2.close
  p s1.read        #=> "pong"
}

static VALUE
bsock_close_write(VALUE sock)
{
    rb_io_t *fptr;

    GetOpenFile(sock, fptr);
    if (!(fptr->mode & FMODE_READABLE)) {
        return rb_io_close(sock);
    }
    shutdown(fptr->fd, 1);
    fptr->mode &= ~FMODE_WRITABLE;

    return Qnil;
}
connect_address() 点击切换源代码

返回适合在本地机器上连接的套接字地址。

此方法返回 self.local_address，除了以下情况。

  • IPv4 未指定地址 (0.0.0.0) 被替换为 IPv4 环回地址 (127.0.0.1)。

  • IPv6 未指定地址 (::) 被替换为 IPv6 环回地址 (::1)。

如果本地地址不适合连接，则会引发 SocketError。端口为 0 的 IPv4 和 IPv6 地址不适合连接。没有路径的 Unix 域套接字不适合连接。

Addrinfo.tcp("0.0.0.0", 0).listen {|serv|
  p serv.connect_address #=> #<Addrinfo: 127.0.0.1:53660 TCP>
  serv.connect_address.connect {|c|
    s, _ = serv.accept
    p [c, s] #=> [#<Socket:fd 4>, #<Socket:fd 6>]
  }
}

# File socket/lib/socket.rb, line 255
def connect_address
  addr = local_address
  afamily = addr.afamily
  if afamily == Socket::AF_INET
    raise SocketError, "unbound IPv4 socket" if addr.ip_port == 0
    if addr.ip_address == "0.0.0.0"
      addr = Addrinfo.new(["AF_INET", addr.ip_port, nil, "127.0.0.1"], addr.pfamily, addr.socktype, addr.protocol)
    end
  elsif defined?(Socket::AF_INET6) && afamily == Socket::AF_INET6
    raise SocketError, "unbound IPv6 socket" if addr.ip_port == 0
    if addr.ip_address == "::"
      addr = Addrinfo.new(["AF_INET6", addr.ip_port, nil, "::1"], addr.pfamily, addr.socktype, addr.protocol)
    elsif addr.ip_address == "0.0.0.0" # MacOS X 10.4 returns "a.b.c.d" for IPv4-mapped IPv6 address.
      addr = Addrinfo.new(["AF_INET6", addr.ip_port, nil, "::1"], addr.pfamily, addr.socktype, addr.protocol)
    elsif addr.ip_address == "::ffff:0.0.0.0" # MacOS X 10.6 returns "::ffff:a.b.c.d" for IPv4-mapped IPv6 address.
      addr = Addrinfo.new(["AF_INET6", addr.ip_port, nil, "::1"], addr.pfamily, addr.socktype, addr.protocol)
    end
  elsif defined?(Socket::AF_UNIX) && afamily == Socket::AF_UNIX
    raise SocketError, "unbound Unix socket" if addr.unix_path == ""
  end
  addr
end
do_not_reverse_lookup → true 或 false 点击切换源代码

获取 basicsocket 的 do_not_reverse_lookup 标志。

require 'socket'

BasicSocket.do_not_reverse_lookup = false
TCPSocket.open("www.ruby-lang.org", 80) {|sock|
  p sock.do_not_reverse_lookup      #=> false
}
BasicSocket.do_not_reverse_lookup = true
TCPSocket.open("www.ruby-lang.org", 80) {|sock|
  p sock.do_not_reverse_lookup      #=> true
}

static VALUE
bsock_do_not_reverse_lookup(VALUE sock)
{
    rb_io_t *fptr;

    GetOpenFile(sock, fptr);
    return (fptr->mode & FMODE_NOREVLOOKUP) ? Qtrue : Qfalse;
}
do_not_reverse_lookup = bool 点击切换源代码

设置 basicsocket 的 do_not_reverse_lookup 标志。

TCPSocket.open("www.ruby-lang.org", 80) {|sock|
  p sock.do_not_reverse_lookup       #=> true
  p sock.peeraddr                    #=> ["AF_INET", 80, "221.186.184.68", "221.186.184.68"]
  sock.do_not_reverse_lookup = false
  p sock.peeraddr                    #=> ["AF_INET", 80, "carbon.ruby-lang.org", "54.163.249.195"]
}

static VALUE
bsock_do_not_reverse_lookup_set(VALUE sock, VALUE state)
{
    rb_io_t *fptr;

    GetOpenFile(sock, fptr);
    if (RTEST(state)) {
        fptr->mode |= FMODE_NOREVLOOKUP;
    }
    else {
        fptr->mode &= ~FMODE_NOREVLOOKUP;
    }
    return sock;
}
getpeereid → [euid, egid] 点击切换源代码

返回 UNIX 套接字对等方的用户和组。结果是一个包含有效 uid 和有效 gid 的两个元素数组。

Socket.unix_server_loop("/tmp/sock") {|s|
  begin
    euid, egid = s.getpeereid

    # Check the connected client is myself or not.
    next if euid != Process.uid

    # do something about my resource.

  ensure
    s.close
  end
}

static VALUE
bsock_getpeereid(VALUE self)
{
#if defined(HAVE_GETPEEREID)
    rb_io_t *fptr;
    uid_t euid;
    gid_t egid;
    GetOpenFile(self, fptr);
    if (getpeereid(fptr->fd, &euid, &egid) == -1)
        rb_sys_fail("getpeereid(3)");
    return rb_assoc_new(UIDT2NUM(euid), GIDT2NUM(egid));
#elif defined(SO_PEERCRED) /* GNU/Linux */
    rb_io_t *fptr;
    struct ucred cred;
    socklen_t len = sizeof(cred);
    GetOpenFile(self, fptr);
    if (getsockopt(fptr->fd, SOL_SOCKET, SO_PEERCRED, &cred, &len) == -1)
        rb_sys_fail("getsockopt(SO_PEERCRED)");
    return rb_assoc_new(UIDT2NUM(cred.uid), GIDT2NUM(cred.gid));
#elif defined(HAVE_GETPEERUCRED) /* Solaris */
    rb_io_t *fptr;
    ucred_t *uc = NULL;
    VALUE ret;
    GetOpenFile(self, fptr);
    if (getpeerucred(fptr->fd, &uc) == -1)
        rb_sys_fail("getpeerucred(3C)");
    ret = rb_assoc_new(UIDT2NUM(ucred_geteuid(uc)), GIDT2NUM(ucred_getegid(uc)));
    ucred_free(uc);
    return ret;
#endif
}
getpeername → sockaddr 点击切换源代码

返回套接字的远程地址，以 sockaddr 字符串形式表示。

TCPServer.open("127.0.0.1", 1440) {|serv|
  c = TCPSocket.new("127.0.0.1", 1440)
  s = serv.accept
  p s.getpeername #=> "\x02\x00\x82u\x7F\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00"
}

如果更希望使用 Addrinfo 对象而不是二进制字符串，请使用 BasicSocket#remote_address。

static VALUE
bsock_getpeername(VALUE sock)
{
    union_sockaddr buf;
    socklen_t len = (socklen_t)sizeof buf;
    socklen_t len0 = len;
    rb_io_t *fptr;

    GetOpenFile(sock, fptr);
    if (getpeername(fptr->fd, &buf.addr, &len) < 0)
        rb_sys_fail("getpeername(2)");
    if (len0 < len) len = len0;
    return rb_str_new((char*)&buf, len);
}
getsockname → sockaddr 点击切换源代码

返回套接字的本地地址，以 sockaddr 字符串形式表示。

TCPServer.open("127.0.0.1", 15120) {|serv|
  p serv.getsockname #=> "\x02\x00;\x10\x7F\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00"
}

如果更希望使用 Addrinfo 对象而不是二进制字符串，请使用 BasicSocket#local_address。

static VALUE
bsock_getsockname(VALUE sock)
{
    union_sockaddr buf;
    socklen_t len = (socklen_t)sizeof buf;
    socklen_t len0 = len;
    rb_io_t *fptr;

    GetOpenFile(sock, fptr);
    if (getsockname(fptr->fd, &buf.addr, &len) < 0)
        rb_sys_fail("getsockname(2)");
    if (len0 < len) len = len0;
    return rb_str_new((char*)&buf, len);
}
getsockopt(level, optname) → socketoption 点击切换源代码

获取套接字选项。这些选项是协议和系统特定的，有关详细信息，请参阅您的本地系统文档。选项将作为 Socket::Option 对象返回。

参数 ↑

  • level 是一个整数，通常是 SOL_ 常量之一，例如 Socket::SOL_SOCKET，或协议级别。也可以接受名称的字符串或符号，可能没有前缀。

  • optname 是一个整数，通常是 SO_ 常量之一，例如 Socket::SO_REUSEADDR。也可以接受名称的字符串或符号，可能没有前缀。

示例 ↑

某些套接字选项是具有布尔值的整数，在这种情况下，可以像这样调用 getsockopt

reuseaddr = sock.getsockopt(:SOCKET, :REUSEADDR).bool

optval = sock.getsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR)
optval = optval.unpack "i"
reuseaddr = optval[0] == 0 ? false : true

某些套接字选项是具有数值的整数，在这种情况下，可以像这样调用 getsockopt

ipttl = sock.getsockopt(:IP, :TTL).int

optval = sock.getsockopt(Socket::IPPROTO_IP, Socket::IP_TTL)
ipttl = optval.unpack1("i")

选项值可能是结构体。解码它们可能很复杂，因为它涉及检查您的系统头文件以确定正确的定义。一个例子是 +struct linger+，它可能在您的系统头文件中定义为

struct linger {
  int l_onoff;
  int l_linger;
};

在这种情况下，可以像这样调用 getsockopt

# Socket::Option knows linger structure.
onoff, linger = sock.getsockopt(:SOCKET, :LINGER).linger

optval =  sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_LINGER)
onoff, linger = optval.unpack "ii"
onoff = onoff == 0 ? false : true

static VALUE
bsock_getsockopt(VALUE sock, VALUE lev, VALUE optname)
{
    int level, option;
    socklen_t len;
    char *buf;
    rb_io_t *fptr;
    int family;

    GetOpenFile(sock, fptr);
    family = rsock_getfamily(fptr);
    level = rsock_level_arg(family, lev);
    option = rsock_optname_arg(family, level, optname);
    len = 256;
#ifdef _AIX
    switch (option) {
      case SO_DEBUG:
      case SO_REUSEADDR:
      case SO_KEEPALIVE:
      case SO_DONTROUTE:
      case SO_BROADCAST:
      case SO_OOBINLINE:
        /* AIX doesn't set len for boolean options */
        len = sizeof(int);
    }
#endif
    buf = ALLOCA_N(char,len);

    rb_io_check_closed(fptr);

    if (getsockopt(fptr->fd, level, option, buf, &len) < 0)
        rsock_sys_fail_path("getsockopt(2)", fptr->pathv);

    return rsock_sockopt_new(family, level, option, rb_str_new(buf, len));
}
local_address → addrinfo 点击切换源代码

返回由 getsockname 获取的本地地址的 Addrinfo 对象。

请注意，addrinfo.protocol 由 0 填充。

TCPSocket.open("www.ruby-lang.org", 80) {|s|
  p s.local_address #=> #<Addrinfo: 192.168.0.129:36873 TCP>
}

TCPServer.open("127.0.0.1", 1512) {|serv|
  p serv.local_address #=> #<Addrinfo: 127.0.0.1:1512 TCP>
}

static VALUE
bsock_local_address(VALUE sock)
{
    union_sockaddr buf;
    socklen_t len = (socklen_t)sizeof buf;
    socklen_t len0 = len;
    rb_io_t *fptr;

    GetOpenFile(sock, fptr);
    if (getsockname(fptr->fd, &buf.addr, &len) < 0)
        rb_sys_fail("getsockname(2)");
    if (len0 < len) len = len0;
    return rsock_fd_socket_addrinfo(fptr->fd, &buf.addr, len);
}
recv(maxlen[, flags[, outbuf]]) → mesg 点击切换源代码

接收消息。

maxlen 是要接收的最大字节数。

flags 应该是 Socket::MSG_* 常量的按位或。

outbuf 即使在方法调用之前不为空，也只包含接收到的数据。

UNIXSocket.pair {|s1, s2|
  s1.puts "Hello World"
  p s2.recv(4)                     #=> "Hell"
  p s2.recv(4, Socket::MSG_PEEK)   #=> "o Wo"
  p s2.recv(4)                     #=> "o Wo"
  p s2.recv(10)                    #=> "rld\n"
}

static VALUE
bsock_recv(int argc, VALUE *argv, VALUE sock)
{
    return rsock_s_recvfrom(sock, argc, argv, RECV_RECV);
}
recv_nonblock(maxlen [, flags [, buf [, options ]]]) → mesg 点击切换源代码

在为底层文件描述符设置 O_NONBLOCK 后，使用 recvfrom(2) 从 socket 接收最多 maxlen 字节。flags 是 MSG_ 选项的零个或多个。结果 mesg 是接收到的数据。

当 recvfrom(2) 返回 0 时，Socket#recv_nonblock 返回 nil。在大多数情况下，这意味着连接已关闭，但对于 UDP 连接，它可能意味着接收到了空数据包，因为底层 API 无法区分这两种情况。

参数 ↑

  • maxlen - 从套接字接收的字节数

  • flags - MSG_ 选项的零个或多个

  • buf - 目标字符串缓冲区

  • options - 关键字哈希，支持 'exception: false`

示例 ↑

serv = TCPServer.new("127.0.0.1", 0)
af, port, host, addr = serv.addr
c = TCPSocket.new(addr, port)
s = serv.accept
c.send "aaa", 0
begin # emulate blocking recv.
  p s.recv_nonblock(10) #=> "aaa"
rescue IO::WaitReadable
  IO.select([s])
  retry
end

有关调用 recv_nonblock 失败时可能抛出的异常，请参阅 Socket#recvfrom。

BasicSocket#recv_nonblock 可能会引发与 recvfrom(2) 失败相对应的任何错误，包括 Errno::EWOULDBLOCK。

如果异常是 Errno::EWOULDBLOCK 或 Errno::EAGAIN，它将由 IO::WaitReadable 扩展。因此，IO::WaitReadable 可用于捕获异常以重试 recv_nonblock。

通过将关键字参数 exception 指定为 false，您可以指示 recv_nonblock 不引发 IO::WaitReadable 异常，而是返回符号 :wait_readable。

参见 ↑

# File socket/lib/socket.rb, line 376
def recv_nonblock(len, flag = 0, str = nil, exception: true)
  __recv_nonblock(len, flag, str, exception)
end
recvmsg(maxmesglen=nil, flags=0, maxcontrollen=nil, opts={}) → [mesg, sender_addrinfo, rflags, *controls] 点击切换源代码

recvmsg 使用 recvmsg(2) 系统调用以阻塞方式接收消息。

maxmesglen 是要接收的 mesg 的最大长度。

flags 是 MSG_* 常量的按位 OR，例如 Socket::MSG_PEEK。

maxcontrollen 是要接收的控制（辅助数据）的最大长度。

opts 是选项哈希。目前，:scm_rights=>bool 是唯一的选项。

:scm_rights 选项指定应用程序是否期望接收 SCM_RIGHTS 控制消息。如果值为 nil 或 false，应用程序不期望接收 SCM_RIGHTS 控制消息。在这种情况下，recvmsg 会立即关闭传递的文件描述符。这是默认行为。

如果 :scm_rights 值既不是 nil 也不是 false，应用程序期望接收 SCM_RIGHTS 控制消息。在这种情况下，recvmsg 会为每个文件描述符创建 IO 对象，用于 Socket::AncillaryData#unix_rights 方法。

返回值是一个包含 4 个元素的数组。

mesg 是接收到的消息的字符串。

sender_addrinfo 是无连接套接字的发送方套接字地址。它是一个 Addrinfo 对象。对于面向连接的套接字（如 TCP），sender_addrinfo 是平台相关的。

rflags 是接收到的消息上的标志，它是 MSG_* 常量（如 Socket::MSG_TRUNC）的按位或运算结果。如果系统使用 4.3BSD 风格的旧 recvmsg 系统调用，它将为 nil。

controls 是辅助数据，它是一个包含 Socket::AncillaryData 对象的数组，例如

#<Socket::AncillaryData: AF_UNIX SOCKET RIGHTS 7>

maxmesglen 和 maxcontrollen 可以为 nil。在这种情况下，缓冲区将不断增长，直到消息不再被截断。在内部，使用 MSG_PEEK。检查缓冲区已满和 MSG_CTRUNC 以确定是否截断。

recvmsg 可以用来实现 recv_io，如下所示

mesg, sender_sockaddr, rflags, *controls = sock.recvmsg(:scm_rights=>true)
controls.each {|ancdata|
  if ancdata.cmsg_is?(:SOCKET, :RIGHTS)
    return ancdata.unix_rights[0]
  end
}

# File socket/lib/socket.rb, line 431
def recvmsg(dlen = nil, flags = 0, clen = nil, scm_rights: false)
  __recvmsg(dlen, flags, clen, scm_rights)
end
recvmsg_nonblock(maxdatalen=nil, flags=0, maxcontrollen=nil, opts={}) → [data, sender_addrinfo, rflags, *controls] click to toggle source

recvmsg 使用 recvmsg(2) 系统调用以非阻塞方式接收消息。

它类似于 BasicSocket#recvmsg，但在系统调用之前设置了非阻塞标志，并且它不会重试系统调用。

通过将关键字参数 exception 指定为 false，您可以指示 recvmsg_nonblock 不应引发 IO::WaitReadable 异常，而是返回符号 :wait_readable。

# File socket/lib/socket.rb, line 447
def recvmsg_nonblock(dlen = nil, flags = 0, clen = nil,
                     scm_rights: false, exception: true)
  __recvmsg_nonblock(dlen, flags, clen, scm_rights, exception)
end
remote_address → addrinfo click to toggle source

返回由 getpeername 获取的远程地址的 Addrinfo 对象。

请注意，addrinfo.protocol 由 0 填充。

TCPSocket.open("www.ruby-lang.org", 80) {|s|
  p s.remote_address #=> #<Addrinfo: 221.186.184.68:80 TCP>
}

TCPServer.open("127.0.0.1", 1728) {|serv|
  c = TCPSocket.new("127.0.0.1", 1728)
  s = serv.accept
  p s.remote_address #=> #<Addrinfo: 127.0.0.1:36504 TCP>
}

static VALUE
bsock_remote_address(VALUE sock)
{
    union_sockaddr buf;
    socklen_t len = (socklen_t)sizeof buf;
    socklen_t len0 = len;
    rb_io_t *fptr;

    GetOpenFile(sock, fptr);
    if (getpeername(fptr->fd, &buf.addr, &len) < 0)
        rb_sys_fail("getpeername(2)");
    if (len0 < len) len = len0;
    return rsock_fd_socket_addrinfo(fptr->fd, &buf.addr, len);
}
send(mesg, flags [, dest_sockaddr]) → numbytes_sent click to toggle source

通过 basicsocket 发送 mesg。

mesg 应该是一个字符串。

flags 应该是 Socket::MSG_* 常量的按位或。

dest_sockaddr 应该是一个打包的 sockaddr 字符串或一个 addrinfo。

TCPSocket.open("localhost", 80) {|s|
  s.send "GET / HTTP/1.0\r\n\r\n", 0
  p s.read
}

VALUE
rsock_bsock_send(int argc, VALUE *argv, VALUE socket)
{
    struct rsock_send_arg arg;
    VALUE flags, to;
    rb_io_t *fptr;
    rb_blocking_function_t *func;
    const char *funcname;

    rb_scan_args(argc, argv, "21", &arg.mesg, &flags, &to);

    StringValue(arg.mesg);
    if (!NIL_P(to)) {
        SockAddrStringValue(to);
        to = rb_str_new4(to);
        arg.to = (struct sockaddr *)RSTRING_PTR(to);
        arg.tolen = RSTRING_SOCKLEN(to);
        func = rsock_sendto_blocking;
        funcname = "sendto(2)";
    }
    else {
        func = rsock_send_blocking;
        funcname = "send(2)";
    }

    RB_IO_POINTER(socket, fptr);

    arg.fd = fptr->fd;
    arg.flags = NUM2INT(flags);

    while (true) {
#ifdef RSOCK_WAIT_BEFORE_BLOCKING
        rb_io_wait(socket, RB_INT2NUM(RUBY_IO_WRITABLE), Qnil);
#endif

        ssize_t n = (ssize_t)BLOCKING_REGION_FD(func, &arg);

        if (n >= 0) return SSIZET2NUM(n);

        if (rb_io_maybe_wait_writable(errno, socket, RUBY_IO_TIMEOUT_DEFAULT)) {
            continue;
        }

        rb_sys_fail(funcname);
    }
}
sendmsg(mesg, flags=0, dest_sockaddr=nil, *controls) → numbytes_sent click to toggle source

sendmsg 使用 sendmsg(2) 系统调用以阻塞方式发送消息。

mesg 是要发送的字符串。

flags 是 MSG_* 常量的按位或运算，例如 Socket::MSG_OOB。

dest_sockaddr 是无连接套接字的目标套接字地址。它应该是一个 sockaddr，例如 Socket.sockaddr_in 的结果。也可以使用 Addrinfo 对象。

controls 是辅助数据的列表。controls 的元素应该是 Socket::AncillaryData 或 3 元素数组。3 元素数组应包含 cmsg_level、cmsg_type 和 data。

返回值 numbytes_sent 是一个整数，表示已发送的字节数。

sendmsg 可用于实现 send_io，如下所示

# use Socket::AncillaryData.
ancdata = Socket::AncillaryData.int(:UNIX, :SOCKET, :RIGHTS, io.fileno)
sock.sendmsg("a", 0, nil, ancdata)

# use 3-element array.
ancdata = [:SOCKET, :RIGHTS, [io.fileno].pack("i!")]
sock.sendmsg("\0", 0, nil, ancdata)

# File socket/lib/socket.rb, line 307
def sendmsg(mesg, flags = 0, dest_sockaddr = nil, *controls)
  __sendmsg(mesg, flags, dest_sockaddr, controls)
end
sendmsg_nonblock(mesg, flags=0, dest_sockaddr=nil, *controls, opts={}) → numbytes_sent 点击切换源代码

sendmsg_nonblock 使用 sendmsg(2) 系统调用以非阻塞方式发送消息。

它类似于 BasicSocket#sendmsg，但在系统调用之前设置了非阻塞标志，并且它不会重试系统调用。

通过将关键字参数 exception 指定为 false，您可以指示 sendmsg_nonblock 不应引发 IO::WaitWritable 异常，而是返回符号 :wait_writable。

# File socket/lib/socket.rb, line 323
def sendmsg_nonblock(mesg, flags = 0, dest_sockaddr = nil, *controls,
                     exception: true)
  __sendmsg_nonblock(mesg, flags, dest_sockaddr, controls, exception)
end
setsockopt(level, optname, optval) 点击切换源代码
setsockopt(socketoption)

设置套接字选项。这些是协议和系统特定的，有关详细信息，请参阅您本地系统的文档。

参数 ↑

  • level 是一个整数，通常是 SOL_ 常量之一，例如 Socket::SOL_SOCKET，或协议级别。也可以接受名称的字符串或符号，可能没有前缀。

  • optname 是一个整数，通常是 SO_ 常量之一，例如 Socket::SO_REUSEADDR。也可以接受名称的字符串或符号，可能没有前缀。

  • optval 是选项的值，它作为指向一定数量字节的指针传递给底层 setsockopt()。如何执行此操作取决于类型

    • 整数：将值分配给 int，并将指向 int 的指针传递给它，长度为 sizeof(int)。

    • true 或 false：1 或 0（分别）被分配给 int，并且 int 被传递给整数。请注意，必须传递 false，而不是 nil。

    • 字符串：字符串的数据和长度被传递给套接字。

  • socketoption 是 Socket::Option 的一个实例。

示例 ↑

一些套接字选项是具有布尔值的整数，在这种情况下，setsockopt 可以这样调用

sock.setsockopt(:SOCKET, :REUSEADDR, true)
sock.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true)
sock.setsockopt(Socket::Option.bool(:INET, :SOCKET, :REUSEADDR, true))

一些套接字选项是具有数值的整数，在这种情况下，setsockopt 可以这样调用

sock.setsockopt(:IP, :TTL, 255)
sock.setsockopt(Socket::IPPROTO_IP, Socket::IP_TTL, 255)
sock.setsockopt(Socket::Option.int(:INET, :IP, :TTL, 255))

选项值可能是结构体。传递它们可能很复杂，因为它涉及检查您的系统头文件以确定正确的定义。一个例子是 ip_mreq，它可能在您的系统头文件中定义为

struct ip_mreq {
  struct  in_addr imr_multiaddr;
  struct  in_addr imr_interface;
};

在这种情况下，setsockopt 可以这样调用

optval = IPAddr.new("224.0.0.251").hton +
         IPAddr.new(Socket::INADDR_ANY, Socket::AF_INET).hton
sock.setsockopt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, optval)

static VALUE
bsock_setsockopt(int argc, VALUE *argv, VALUE sock)
{
    VALUE lev, optname, val;
    int family, level, option;
    rb_io_t *fptr;
    int i;
    char *v;
    int vlen;

    if (argc == 1) {
        lev = rb_funcall(argv[0], rb_intern("level"), 0);
        optname = rb_funcall(argv[0], rb_intern("optname"), 0);
        val = rb_funcall(argv[0], rb_intern("data"), 0);
    }
    else {
        rb_scan_args(argc, argv, "30", &lev, &optname, &val);
    }

    GetOpenFile(sock, fptr);
    family = rsock_getfamily(fptr);
    level = rsock_level_arg(family, lev);
    option = rsock_optname_arg(family, level, optname);

    switch (TYPE(val)) {
      case T_FIXNUM:
        i = FIX2INT(val);
        goto numval;
      case T_FALSE:
        i = 0;
        goto numval;
      case T_TRUE:
        i = 1;
      numval:
        v = (char*)&i; vlen = (int)sizeof(i);
        break;
      default:
        StringValue(val);
        v = RSTRING_PTR(val);
        vlen = RSTRING_SOCKLEN(val);
        break;
    }

    rb_io_check_closed(fptr);
    if (setsockopt(fptr->fd, level, option, v, vlen) < 0)
        rsock_sys_fail_path("setsockopt(2)", fptr->pathv);

    return INT2FIX(0);
}
shutdown([how]) → 0 点击切换源代码

调用 shutdown(2) 系统调用。

s.shutdown(Socket::SHUT_RD) 禁止进一步读取。

s.shutdown(Socket::SHUT_WR) 禁止进一步写入。

s.shutdown(Socket::SHUT_RDWR) 禁止进一步读取和写入。

how 可以是符号或字符串

  • :RD, :SHUT_RD, “RD” 和 “SHUT_RD” 被接受为 Socket::SHUT_RD。

  • :WR, :SHUT_WR, “WR” 和 “SHUT_WR” 被接受为 Socket::SHUT_WR。

  • :RDWR, :SHUT_RDWR, “RDWR” 和 “SHUT_RDWR” 被接受为 Socket::SHUT_RDWR。

    UNIXSocket.pair {|s1, s2|

    s1.puts "ping"
s1.shutdown(:WR)
p s2.read          #=> "ping\n"
s2.puts "pong"
s2.close
p s1.read          #=> "pong\n"

    }

static VALUE
bsock_shutdown(int argc, VALUE *argv, VALUE sock)
{
    VALUE howto;
    int how;
    rb_io_t *fptr;

    rb_scan_args(argc, argv, "01", &howto);
    if (howto == Qnil)
        how = SHUT_RDWR;
    else {
        how = rsock_shutdown_how_arg(howto);
        if (how != SHUT_WR && how != SHUT_RD && how != SHUT_RDWR) {
            rb_raise(rb_eArgError, "`how' should be either :SHUT_RD, :SHUT_WR, :SHUT_RDWR");
        }
    }
    GetOpenFile(sock, fptr);
    if (shutdown(fptr->fd, how) == -1)
        rb_sys_fail("shutdown(2)");

    return INT2FIX(0);
}