splice_from_pipe_feed(9) [centos man page]

SPLICE_FROM_PIPE_FEE(9) 					    splice API						   SPLICE_FROM_PIPE_FEE(9)

NAME

       splice_from_pipe_feed - feed available data from a pipe to a file

SYNOPSIS

       int splice_from_pipe_feed(struct pipe_inode_info * pipe, struct splice_desc * sd, splice_actor * actor);

ARGUMENTS

       pipe
	   pipe to splice from

       sd
	   information to actor

       actor
	   handler that splices the data

DESCRIPTION

       This function loops over the pipe and calls actor 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 (sd->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.

       This, together with splice_from_pipe_{begin,end,next}, may be used to implement the functionality of __splice_from_pipe when locking is
       required around copying the pipe buffers to the destination.

COPYRIGHT

Kernel Hackers Manual 3.10					     June 2014						   SPLICE_FROM_PIPE_FEE(9)

PIPE(2) 							System Calls Manual							   PIPE(2)

NAME

       pipe - create an interprocess communication channel

SYNOPSIS

       pipe(fildes)
       int fildes[2];

DESCRIPTION

       The pipe system call creates an I/O mechanism called a pipe.  The file descriptors returned can be used in read and write operations.  When
       the pipe is written using the descriptor fildes[1] up to 4096 bytes of data are buffered before the writing process is suspended.   A  read
       using the descriptor fildes[0] will pick up the data.

       It  is  assumed	that after the pipe has been set up, two (or more) cooperating processes (created by subsequent fork calls) will pass data
       through the pipe with read and write calls.

       The shell has a syntax to set up a linear array of processes connected by pipes.

       Read calls on an empty pipe (no buffered data) with only one end (all write file descriptors closed) returns an end-of-file.

       Pipes are really a special case of the socketpair(2) call and, in fact, are implemented as such in the system.

       A signal is generated if a write on a pipe with only one end is attempted.

RETURN VALUE

       The function value zero is returned if the pipe was created; -1 if an error occurred.

ERRORS

       The pipe call will fail if:

       [EMFILE]       Too many descriptors are active.

       [ENFILE]       The system file table is full.

       [EFAULT]       The fildes buffer is in an invalid area of the process's address space.

SEE ALSO

       sh(1), read(2), write(2), fork(2), socketpair(2)

BUGS

       Should more than 4096 bytes be necessary in any pipe among a loop of processes, deadlock will occur.

4th Berkeley Distribution					  August 26, 1985							   PIPE(2)