HACKING ISSUES LICENSE NEWS README
Kgio DefaultWaiters File Pipe PipeMethods Socket SocketMethods TCPServer TCPSocket UNIXServer UNIXSocket

Methods

::accept_class ::accept_class= ::accept_cloexec= ::accept_cloexec? ::accept_nonblock= ::accept_nonblock? ::autopush= ::autopush? ::poll

module Kgio

See the README

Constants

LOCALHOST

The IPv4 address of UNIX domain sockets, useful for creating Rack (and CGI) servers that also serve HTTP traffic over UNIX domain sockets.

MSG_FASTOPEN

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.

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.

TCP_FASTOPEN

WaitReadable

Kgio::PipeMethods#kgio_tryread and Kgio::SocketMethods#kgio_tryread will return :wait_readable when waiting for a read is required.

WaitWritable

PipeMethods#kgio_trywrite and SocketMethods#kgio_trywrite will return :wait_writable when waiting for a read is required.

Public Class Methods

accept_class () source

Returns the default class for newly accepted sockets when kgio_accept or kgio_tryaccept are not passed arguments

accept_class= (p1) source

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.

Kgio.accept_cloexec = true
Kgio.accept_cloexec = false source

Sets whether or not Kgio::Socket objects created by Kgio::TCPServer#kgio_accept, Kgio::TCPServer#kgio_tryaccept, Kgio::UNIXServer#kgio_accept, and Kgio::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.

Kgio.accept_cloexec? -> true or false source

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.

Kgio.accept_nonblock = true
Kgio.accept_nonblock = false source

Sets whether or not Kgio::Socket objects created by Kgio::TCPServer#kgio_accept, Kgio::TCPServer#kgio_tryaccept, Kgio::UNIXServer#kgio_accept, and Kgio::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.

Kgio.accept_nonblock? -> true or false source

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.

Kgio.autopush = true
Kgio.autopush = false source

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.

Kgio.autopush? -> true or false source

Returns whether or not autopush is enabled.

Only available on systems with TCP_CORK (Linux) or TCP_NOPUSH (FreeBSD, and maybe other *BSDs).

Kgio.poll({ $stdin => :wait_readable }, 100)  -> hash or nil
Kgio.poll({ $stdin => Kgio::POLLIN }, 100)  -> hash or nil source

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.

::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()


Pages Classes Methods
mail archives: https://bogomips.org/kgio-public/
	nntp://news.public-inbox.org/inbox.comp.lang.ruby.kgio 
	nntp://news.gmane.org/gmane.comp.lang.ruby.kgio.general 
public: kgio-public@bogomips.org / private: kgio@bogomips.org