Stdio.Fd()->read()

Stdio.Fd()->seek()

Method Stdio.Fd()->read_oob()

Method read_oob

string Stdio.Fd()->read_oob()
string Stdio.Fd()->read_oob(int len)
string Stdio.Fd()->read_oob(int len, int(0..1) not_all)

Description

Read out-of-band data from a stream.

Attempts to read len bytes of out-of-band data from the stream, and returns it as a string. If something goes wrong, zero is returned.

If a one is given as the second argument to Stdio.Fd.read_oob, only as many bytes of out-of-band data as are currently available will be returned.

If no arguments are given, Stdio.Fd.read_oob will read to the end of the stream.

Note

This function is only available if the option '--without-oob' was not specified when the Pike runtime was compiled.

It is not guaranteed that all out-of-band data sent from the other end will be received. Most streams only allow for a single byte of out-of-band data at a time.

See also

Stdio.Fd.read, Stdio.Fd.write_oob