wait.md

type	library
category	I/O

IOが読み込み可能になるまで待つ機能を提供するライブラリです。

Windowsではこのライブラリで定義されているメソッドは Socketに対してしか利用できません。

reopen IO

Instance Methods

def nread -> Integer

ブロックせずに読み込み可能なバイト数を返します。 ブロックする場合は0を返します。

判別が不可能な場合は0を返します。

#@if (version == "3.0")

def ready? -> IO | false | nil

ブロックせずに読み込み可能なら真を、 #@else

def ready? -> bool | nil

ブロックせずに読み込み可能ならtrueを、 #@end ブロックしてしまう可能性があるならfalseを返します。

判定不可能な場合は nil を返します。

def wait(timeout = nil) -> bool | self | nil

def wait_readable(timeout = nil) -> bool | self | nil

self が読み込み可能になるまでブロックし、読み込み可能になったら 真値を返します。タイムアウト、もしくはEOFで それ以上読みこめない場合は偽の値を返します。

より詳しくは、一度ブロックしてから読み込み可能になった場合には selfを返します。 内部のバッファにデータがある場合には ブロックせずに true を返します。 内部のバッファとはRubyの処理系が保持管理している バッファのことです。

つまり、読み込み可能である場合にはtrueを返す場合と selfを返す場合があることに注意してください。

timeout を指定した場合は、指定秒数経過するまでブロックし、タ イムアウトした場合は nil を返します。

self が EOF に達していれば false を返します。

• param timeout -- タイムアウトまでの秒数を指定します。

• SEE [m:IO#wait_writable]

def wait_writable -> self

def wait_writable(timeout) -> self | nil

self が書き込み可能になるまでブロックし、書き込み可能になったら self を 返します。

timeout を指定した場合は、指定秒数経過するまでブロックし、タイムアウト した場合は nil を返します。

• param timeout -- タイムアウトまでの秒数を指定します。

• SEE [m:IO#wait_readable]

#@since 3.0

def wait_priority(timeout = nil) -> bool | self | nil

self が優先データを受信して読み込み可能になるまでブロックし、 読み込み可能になったら真値を返します。

優先データ(緊急データ)は [m:Socket::Constants::MSG_OOB] フラグを用いて 送受信され、通常はストリーム型のソケットに限られます。

より詳しくは、一度ブロックしてから読み込み可能になった場合には self を返します。 内部のバッファにデータがある場合には ブロックせずに true を返します。

timeout を指定した場合は、指定秒数経過するまでブロックし、タ イムアウトした場合は nil を返します。

• param timeout -- タイムアウトまでの秒数を指定します。 nil を指定すると読み込み可能になるまで待ち続けます。

• SEE [m:IO#wait_readable], [m:IO#wait_writable] #@end