<?xml version="1.0" encoding="ANSI_X3.4-1968" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968" /><title>splice_from_pipe_feed</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /><link rel="home" href="index.html" title="Linux Filesystems API" /><link rel="up" href="ch06.html" title="Chapter 6. splice API" /><link rel="prev" href="re212.html" title="generic_file_splice_read" /><link rel="next" href="re214.html" title="splice_from_pipe_next" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span>splice_from_pipe_feed</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re212.html">Prev</a> </td><th width="60%" align="center">Chapter 6. splice API</th><td width="20%" align="right"> <a accesskey="n" href="re214.html">Next</a></td></tr></table><hr /></div><div class="refentry" title="splice_from_pipe_feed"><a id="API-splice-from-pipe-feed"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>splice_from_pipe_feed —
feed available data from a pipe to a file
</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">int <b class="fsfunc">splice_from_pipe_feed </b>(</code></td><td>struct pipe_inode_info * <var class="pdparam">pipe</var>, </td></tr><tr><td> </td><td>struct splice_desc * <var class="pdparam">sd</var>, </td></tr><tr><td> </td><td>splice_actor * <var class="pdparam">actor</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Arguments"><a id="id3037102"></a><h2>Arguments</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>pipe</code></em></span></dt><dd><p>
pipe to splice from
</p></dd><dt><span class="term"><em class="parameter"><code>sd</code></em></span></dt><dd><p>
information to <em class="parameter"><code>actor</code></em>
</p></dd><dt><span class="term"><em class="parameter"><code>actor</code></em></span></dt><dd><p>
handler that splices the data
</p></dd></dl></div></div><div class="refsect1" title="Description"><a id="id3037168"></a><h2>Description</h2><p>
This function loops over the pipe and calls <em class="parameter"><code>actor</code></em> to do the
actual moving of a single struct pipe_buffer to the desired
destination. It returns when there's no more buffers left in
the pipe or if the requested number of bytes (<em class="parameter"><code>sd</code></em>->total_len)
have been copied. It returns a positive number (one) if the
pipe needs to be filled with more data, zero if the required
number of bytes have been copied and -errno on error.
</p><p>
This, together with splice_from_pipe_{begin,end,next}, may be
used to implement the functionality of <code class="function">__splice_from_pipe</code> when
locking is required around copying the pipe buffers to the
destination.
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="re212.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch06.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="re214.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span>generic_file_splice_read</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <span>splice_from_pipe_next</span></td></tr></table></div></body></html>
