Log of autodoc.git/traditional_manual/chapter

2010-11-19

2010-11-19 11:21:31 by Henrik Grubbström (Grubba) <grubba@grubba.org>

60c5b282b9473a60d94c398cc436bf4d623555d8 (102 lines) (+96/-6) ^{[

Show
| Annotate

]}
Branch: 8.0

Added Stdio.File()->{send,receive}_fd().

File descriptors may now be sent and received over UNIX-domain sockets.

937: </td></tr> <tr><td><code><code class='key'>PROP_BIDIRECTIONAL</code></code></td><td>The resulting pipe is bi-directional. </td></tr> - <tr><td><code><code class='key'>PROP_SEND_FD</code></code></td><td>The resulting pipe might support sending of file descriptors. + <tr><td><code><code class='key'>PROP_SEND_FD</code></code></td><td>The resulting pipe might support sending of file descriptors + (see <code>send_fd()</code> and <code>receive_fd()</code> for details). </td></tr> <tr><td><code><code class='key'>PROP_REVERSE</code></code></td><td>The resulting pipe supports communication "backwards" (but not necessarily "forwards", see <code>PROP_BIDIRECTIONAL</code>).
956: same as calling it with no arguments. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Process.create_process()</code>, + <dd class='body--doc'><code>Process.create_process()</code>, <code>send_fd()</code>, <code>receive_fd()</code>, <code>PROP_IPC</code>, <code>PROP_NONBLOCK</code>, <code>PROP_SEND_FD</code>, <code>PROP_SHUTDOWN</code>, <code>PROP_BUFFERED</code>, <code>PROP_REVERSE</code>, <code>PROP_BIDIRECTIONAL</code>
1214: <hr /> <dl class='group--doc'> <dt class='head--type'>Method + receive_fd + </dt> + <dd><code><code class='datatype'>void</code> receive_fd(<code class='object unresolved'>Stdio.Fd</code> <code class='argument'>fd</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Remote file descriptor reception handler. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>fd</code></dt> + <dd></dd><dd class='body--doc'>File descriptor received from the remote end of a <code>pipe()</code>. + This object has been created by <code>fd_factory()</code>. + This function is called from <code>read()</code> when a remote file + descriptor has been received over a <code>PROP_SEND_FD</code> + capable <code>pipe()</code>. + The default implementation is just a prototype. + Overload this function to enable reception of + remote file descriptors. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The capability of sending and receiving remote file + descriptors is only available on some operating systems. + This capability is indicated by the precence of <code>__HAVE_SEND_FD__</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>send_fd()</code>, <code>read()</code>, <code>fd_factory()</code>, <code>__HAVE_SEND_FD__</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method release_fd </dt> <dd><code><code class='datatype'>int</code> release_fd()</code></dd>
1273: <hr /> <dl class='group--doc'> <dt class='head--type'>Method + send_fd + </dt> + <dd><code><code class='datatype'>void</code> send_fd(<code class='object unresolved'>Stdio.Fd</code> <code class='argument'>fd</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Queues an open file descriptor for sending to the other end of a stream. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The actual sending is performed at the next successful call + to <code>write()</code>, this is due to limitations in the system calls. + This means that it isn't possible to send a file descriptor + without also sending some in-band data. + This operation is only supported on <code>pipe()</code>'s created with + <code>PROP_SEND_FD</code>. + This function is not available on all operating systems, check + for <code>__HAVE_SEND_FD__</code>. + The queue is emptied on successful <code>write()</code> and when the + write direction is <code>close()</code>'d. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>receive_fd()</code>, <code>write()</code>, <code>pipe()</code>, <code>read()</code>, <code>__HAVE_SEND_FD__</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + send_fd + </dt> + <dd><code><code class='datatype'>bool</code> send_fd(<code class='object unresolved'>File</code>|<code class='object unresolved'>Fd</code> <code class='argument'>file</code>)</code></dd> + </dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method set_backend </dt> <dd><code><code class='datatype'>void</code> set_backend(<code class='object unresolved'>Pike.Backend</code> <code class='argument'>backend</code>)</code></dd>
1909: If more than one argument is given, <code>sprintf()</code> is used to format them using <code>format</code>. If <code>format</code> is an array, the strings in it are concatenated and the result is used as format string. + If there are any file descriptors that have been queued for sending + (with <code>send_fd()</code>), they will be sent. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>Writing of wide strings is not supported. You have to encode the
1916: charsets supported by <code>Locale.Charset.encoder</code>. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>read()</code>, <code>write_oob()</code> + <dd class='body--doc'><code>read()</code>, <code>write_oob()</code>, <code>send_fd()</code> </dd></dl>
4447: <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Stdio.<code class='constant'>PROP_SEND_FD</code></code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The <code>Stdio.File</code> object might support sending of open - file descriptors. + <dd class='body--doc'>The <code>Stdio.File</code> object might support the <code>Stdio.File()->send_fd()</code> + operation. </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Stdio.File()->pipe()</code> + <dd class='body--doc'><code>Stdio.File()->pipe()</code>, <code>Stdio.File()->send_fd()</code>, + <code>Stdio.File()->receive_fd()</code> </dd></dl>
4555: <hr /> <dl class='group--doc'> <dt class='head--type'>Constant + __HAVE_SEND_FD__ + </dt> + <dd><code><code class='datatype'>constant</code> Stdio.<code class='constant'>__HAVE_SEND_FD__</code></code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Support for sending of file descriptors over + <code>Stdio.File()->pipe()</code> objects with <code>PROP_SEND_FD</code> + capability is supported. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Stdio.File()->send_fd()</code>, <code>Stdio.File()->receive_fd()</code>, + <code>Stdio.File()->read()</code>, <code>Stdio.File()->write()</code>, + <code>Stdio.File()->pipe()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Constant __OOB__ </dt> <dd><code><code class='datatype'>constant</code> Stdio.<code class='constant'>__OOB__</code></code></dd>

autodoc.git/ traditional_manual/ chapter_9.html

2010-11-19

2010-11-19 11:21:31 by Henrik Grubbström (Grubba) <grubba@grubba.org>