Module: Kgio
- Defined in:
- lib/kgio.rb,
ext/kgio/accept.c,
ext/kgio/autopush.c,
ext/kgio/connect.c,
ext/kgio/kgio_ext.c,
ext/kgio/kgio_ext.c,
ext/kgio/poll.c,
ext/kgio/wait.c,
ext/kgio/tryopen.c
Overview
See the README
Defined Under Namespace
Modules: DefaultWaiters, PipeMethods, SocketMethods Classes: File, Pipe, Socket, TCPServer, TCPSocket, UNIXServer, UNIXSocket
Constant Summary collapse
- LOCALHOST =
The IPv4 address of UNIX domain sockets, useful for creating Rack (and CGI) servers that also serve HTTP traffic over UNIX domain sockets.
'127.0.0.1'
- WaitReadable =
Kgio::PipeMethods#kgio_tryread and Kgio::SocketMethods#kgio_tryread will return :wait_readable when waiting for a read is required.
:wait_readable
- WaitWritable =
PipeMethods#kgio_trywrite and SocketMethods#kgio_trywrite will return :wait_writable when waiting for a read is required.
:wait_writable
- SOCK_NONBLOCK =
Maps to the SOCK_NONBLOCK constant in Linux for setting the non-blocking flag on newly accepted sockets. This is usually unnecessary as sockets are made non-blocking whenever non-blocking methods are used.
INT2NUM(SOCK_NONBLOCK)
- SOCK_CLOEXEC =
Maps to the SOCK_CLOEXEC constant in Linux for setting the close-on-exec flag on newly accepted descriptors. This is enabled by default, and there is usually no reason to disable close-on-exec for accepted sockets.
INT2NUM(SOCK_CLOEXEC)
- TCP_FASTOPEN =
INT2NUM(TCP_FASTOPEN)
- MSG_FASTOPEN =
INT2NUM(MSG_FASTOPEN)
Class Method Summary collapse
-
.accept_class ⇒ Object
Returns the default class for newly accepted sockets when kgio_accept or kgio_tryaccept are not passed arguments.
-
.accept_class=(aclass) ⇒ Object
Sets the default class for newly accepted sockets.
-
.accept_cloexec=(boolean) ⇒ Object
Kgio.accept_cloexec = true Kgio.accept_cloexec = false.
-
.accept_cloexec? ⇒ Boolean
Kgio.accept_cloexec? -> true or false.
-
.accept_nonblock=(boolean) ⇒ Object
Kgio.accept_nonblock = true Kgio.accept_nonblock = false.
-
.accept_nonblock? ⇒ Boolean
Kgio.accept_nonblock? -> true or false.
-
.autopush=(val) ⇒ Object
Kgio.autopush = true Kgio.autopush = false.
-
.autopush? ⇒ Boolean
Kgio.autopush? -> true or false.
-
.poll(*args) ⇒ Object
Kgio.poll({ $stdin => :wait_readable }, 100) -> hash or nil Kgio.poll({ $stdin => Kgio::POLLIN }, 100) -> hash or nil.
Class Method Details
.accept_class ⇒ Object
Returns the default class for newly accepted sockets when kgio_accept or kgio_tryaccept are not passed arguments
59 60 61 62 |
# File 'ext/kgio/accept.c', line 59
static VALUE get_accepted(VALUE klass)
{
return cClientSocket;
}
|
.accept_class=(aclass) ⇒ Object
Sets the default class for newly accepted sockets. This is legacy behavior, kgio_accept and kgio_tryaccept now take optional class arguments to override this value.
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
# File 'ext/kgio/accept.c', line 36
static VALUE set_accepted(VALUE klass, VALUE aclass)
{
VALUE tmp;
if (NIL_P(aclass))
aclass = cKgio_Socket;
tmp = rb_funcall(aclass, rb_intern("included_modules"), 0);
tmp = rb_funcall(tmp, rb_intern("include?"), 1, mSocketMethods);
if (tmp != Qtrue)
rb_raise(rb_eTypeError,
"class must include Kgio::SocketMethods");
cClientSocket = aclass;
return aclass;
}
|
.accept_cloexec=(boolean) ⇒ Object
Kgio.accept_cloexec = true Kgio.accept_cloexec = false
Sets whether or not Kgio::Socket objects created by TCPServer#kgio_accept, TCPServer#kgio_tryaccept, UNIXServer#kgio_accept, and UNIXServer#kgio_tryaccept default to being created with the FD_CLOEXEC file descriptor flag.
This is on by default, as there is little reason to deal to enable it for client sockets on a socket server.
Deprecated, use the per-socket flags for kgio_*accept instead.
429 430 431 432 433 434 435 436 437 438 439 440 441 |
# File 'ext/kgio/accept.c', line 429
static VALUE set_cloexec(VALUE mod, VALUE boolean)
{
switch (TYPE(boolean)) {
case T_TRUE:
accept4_flags |= SOCK_CLOEXEC;
return boolean;
case T_FALSE:
accept4_flags &= ~SOCK_CLOEXEC;
return boolean;
}
rb_raise(rb_eTypeError, "not true or false");
return Qnil;
}
|
.accept_cloexec? ⇒ Boolean
Kgio.accept_cloexec? -> true or false
Returns true if newly accepted Kgio::Sockets are created with the FD_CLOEXEC file descriptor flag, false if not.
Deprecated, use the per-socket flags for kgio_*accept instead.
390 391 392 393 |
# File 'ext/kgio/accept.c', line 390
static VALUE get_cloexec(VALUE mod)
{
return (accept4_flags & SOCK_CLOEXEC) == SOCK_CLOEXEC ? Qtrue : Qfalse;
}
|
.accept_nonblock=(boolean) ⇒ Object
Kgio.accept_nonblock = true Kgio.accept_nonblock = false
Sets whether or not Kgio::Socket objects created by TCPServer#kgio_accept, TCPServer#kgio_tryaccept, UNIXServer#kgio_accept, and UNIXServer#kgio_tryaccept are created with the O_NONBLOCK file status flag.
This defaults to false
for GNU/Linux where MSG_DONTWAIT is available (and on newer GNU/Linux, accept4() may also set the non-blocking flag. This defaults to true
on non-GNU/Linux systems.
This is always true on Ruby implementations using user-space threads.
Deprecated, use the per-socket flags for kgio_*accept instead.
465 466 467 468 469 470 471 472 473 474 475 476 477 |
# File 'ext/kgio/accept.c', line 465
static VALUE set_nonblock(VALUE mod, VALUE boolean)
{
switch (TYPE(boolean)) {
case T_TRUE:
accept4_flags |= SOCK_NONBLOCK;
return boolean;
case T_FALSE:
accept4_flags &= ~SOCK_NONBLOCK;
return boolean;
}
rb_raise(rb_eTypeError, "not true or false");
return Qnil;
}
|
.accept_nonblock? ⇒ Boolean
Kgio.accept_nonblock? -> true or false
Returns true if newly accepted Kgio::Sockets are created with the O_NONBLOCK file status flag, false if not.
Deprecated, use the per-socket flags for kgio_*accept instead.
406 407 408 409 |
# File 'ext/kgio/accept.c', line 406
static VALUE get_nonblock(VALUE mod)
{
return (accept4_flags & SOCK_NONBLOCK)==SOCK_NONBLOCK ? Qtrue : Qfalse;
}
|
.autopush=(val) ⇒ Object
Kgio.autopush = true Kgio.autopush = false
Enables or disables autopush for sockets created with kgio_accept and kgio_tryaccept methods. Autopush relies on TCP_CORK/TCP_NOPUSH being enabled on the listen socket.
Only available on systems with TCP_CORK (Linux) or TCP_NOPUSH (FreeBSD, and maybe other *BSDs).
Please do not use this (or kgio at all) in new code. Under Linux, use MSG_MORE, instead, as it requires fewer syscalls. Users of other systems are encouraged to add MSG_MORE support to their favorite OS.
113 114 115 116 117 118 |
# File 'ext/kgio/autopush.c', line 113
static VALUE s_set_autopush(VALUE self, VALUE val)
{
enabled = RTEST(val);
return val;
}
|
.autopush? ⇒ Boolean
Kgio.autopush? -> true or false
Returns whether or not autopush is enabled.
Only available on systems with TCP_CORK (Linux) or TCP_NOPUSH (FreeBSD, and maybe other *BSDs).
91 92 93 94 |
# File 'ext/kgio/autopush.c', line 91
static VALUE s_get_autopush(VALUE self)
{
return enabled ? Qtrue : Qfalse;
}
|
.poll(*args) ⇒ Object
Kgio.poll({ $stdin => :wait_readable }, 100) -> hash or nil Kgio.poll({ $stdin => Kgio::POLLIN }, 100) -> hash or nil
Accepts an input hash with IO objects to wait for as the key and the events to wait for as its value. The events may either be :wait_readable
or :wait_writable
symbols or a Fixnum mask of Kgio::POLL* constants:
Kgio::POLLIN - there is data to read Kgio::POLLPRI - there is urgent data to read Kgio::POLLOUT - writing will not block Kgio::POLLRDHUP - peer has shutdown writes (Linux 2.6.17+ only)
Timeout is specified in Integer milliseconds just like the underlying poll(2), not in seconds like IO.select. A nil timeout means to wait forever. It must be an Integer or nil.
Kgio.poll modifies and returns its input hash on success with the IO-like object as the key and an Integer mask of events as the hash value. It can return any of the events specified in the input above, along with the following events:
Kgio::POLLERR - error condition occurred on the descriptor Kgio::POLLHUP - hang up Kgio::POLLNVAL - invalid request (bad file descriptor)
This method is only available under Ruby 1.9 or any other implementations that uses native threads and rb_thread_blocking_region()
208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'ext/kgio/poll.c', line 208
static VALUE s_poll(int argc, VALUE *argv, VALUE self)
{
VALUE timeout;
struct poll_args a;
rb_scan_args(argc, argv, "11", &a.ios, &timeout);
a.timeout = num2timeout(timeout);
a.fds = NULL;
a.fd_to_io = NULL;
return rb_ensure(do_poll, (VALUE)&a, poll_free, (VALUE)&a);
}
|