Extracted from Pike v7.4 release 341 at 2005-11-21.
pike.ida.liu.se
[Top]
predef::
Stdio
Stdio.File

Method Stdio.File()->write_oob()


Method write_oob

int write_oob(string data)
int write_oob(string format, mixed ... extras)

Description

Write out-of-band data to a stream.

Writes out-of-band data to a stream and returns how many bytes that were actually written.

If more than one argument is given, sprintf() will be used to format them.

-1 is returned if something went wrong and no bytes were written.

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. Some streams will send the rest of the data as ordinary data.

See also

read_oob() , write()