Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wording #1

Merged
merged 1 commit into from Feb 1, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions lib/Linux/PipeMagic.pm
Expand Up @@ -80,7 +80,7 @@ Linux::PipeMagic - Perl extension to use the zero copy IO syscalls
=head1 DESCRIPTION

Linux::PipeMagic is a Perl XS wrapper around the L<splice(2)>, L<tee(2)> and L<sendfile(2)>
syscalls. You can use them to efficiently data from one file descriptor to
syscalls. You can use them to efficiently copy data from one file descriptor to
another inside the kernel (splice), or to efficiently copy data from one pipe
to another (tee).

Expand All @@ -90,19 +90,19 @@ to another (tee).

=item sysplice($fh_in, $fh_out, $num_bytes, $flags)

Moves C<$num_bytes> from C<$fh_in> to C<$fh_out>. This is roughly equivilent to,
Copies C<$num_bytes> from C<$fh_in> to C<$fh_out>. This is roughly equivalent to,

sysread($fh_in, my $buf, $num_bytes);
syswrite($fh_out, $buf);

although the transfer takes place entirely in kernel-space.
although the transfer takes place entirely in kernel space.

Returns the number of bytes transferred.

=item systee($fh_in, $fh_out, $num_bytes, $flags)

Copies C<$num_bytes> from C<$fh_in> to C<$fh_out>. The filehandles must both
be of pipes. This works similarly to C<syssplice>, but does not advance the
be of type pipe. This works similarly like C<syssplice> but does not advance the
read pointer in C<$fh_in>.

Returns the number of bytes transferred.
Expand Down