pipe()

Create a pipe

Synopsis:

#include <unistd.h>

int pipe( int fildes[2] );

Arguments:

fildes

An array where the function can store the file descriptors for the ends of the pipe.

Library:

libc

Use the -l c option to qcc to link against this library. This library is usually included automatically.

Description:

The pipe() function creates a pipe (an unnamed FIFO) and places a file descriptor for the read end of the pipe in fildes[0], and a file descriptor for the write end of the pipe in fildes[1]. Their integer values are the two lowest available at the time of the pipe() function call. The O_NONBLOCK flag is cleared for both file descriptors. (You can use fcntl() to set the O_NONBLOCK flag.)

You can write data to file descriptor fildes[1] and read it from file descriptor fildes[0]. If you read from file descriptor fildes[0], it returns the data written to fildes[1] on a first-in-first-out (FIFO) basis.

The pipe buffer is allocated by the pipe resource manager.

You typically use this function to connect standard utilities acting as filters, passing the write end of the pipe to the data-producing process as its STDOUT_FILENO, and the read end of the pipe to the data-consuming process as its STDIN_FILENO (either via the traditional fork(), dup2(), or exec*, or the more efficient spawn* calls).

If successful, pipe() marks the st_ftime, st_ctime, st_atime and st_mtime fields of the pipe for updating.

Returns:

0

Success.

-1

An error occurred (errno is set).

Errors:

EMFILE

The calling process doesn't have at least 2 unused file descriptors available.

ENFILE

The number of simultaneously open files in the system would exceed the configured limit.

ENOSPC

There's insufficient space available to allocate the pipe buffer.

ENOSYS

There's no pipe manager running.

EROFS

The pipe pathname space is a read-only filesystem.

Classification:

POSIX 1003.1

See also:

errno, fcntl(), nbaconnect(), open(), popen(), read(), write()

pipe in the Utilities Reference