—package
Proc::Hevy::Writer;
use
strict;
use
warnings;
use
Carp;
use
IO::Pipe;
use
POSIX ();
sub
new {
my
(
$class
,
$name
,
$buffer
) =
@_
;
my
$pipe
;
$pipe
= IO::Pipe->new
if
defined
$buffer
and
ref
$buffer
ne
'GLOB'
;
bless
{
name
=>
$name
,
buffer
=>
$buffer
,
pipe
=>
$pipe
},
$class
;
}
sub
child {
my
(
$self
,
$std_h
,
$fileno
) =
@_
;
my
$handle
;
if
(
defined
$self
->{
pipe
} ) {
$handle
=
$self
->{
pipe
}->reader;
}
elsif
(
ref
$self
->{buffer} eq
'GLOB'
) {
$handle
=
$self
->{buffer};
}
else
{
open
$handle
,
'<'
,
'/dev/null'
or confess
"$self->{name}: open: /dev/null: $!\n"
;
}
POSIX::dup2(
$handle
->
fileno
,
$fileno
)
or confess
"$self->{name}: fdopen: $!\n"
if
$std_h
!=
$handle
;
}
sub
parent {
my
(
$self
,
$select
) =
@_
;
unless
(
defined
$self
->{
pipe
} ) {
delete
$self
->{buffer}
if
defined
$self
->{buffer};
return
;
}
$self
->{scratch} =
''
;
my
$handle
=
$self
->{
pipe
}->writer;
$handle
->blocking( 0 );
$select
->add(
$handle
);
$self
->{
select
} =
$select
;
return
(
$handle
,
$self
);
}
sub
write
{
my
(
$self
) =
@_
;
my
$handle
=
$self
->{
pipe
};
if
(
length
(
$self
->{scratch} ) == 0 ) {
my
$scratch
=
$self
->_unpack;
unless
(
defined
$scratch
) {
$self
->{
select
}->remove(
$handle
);
$handle
->
close
or confess
"$self->{name}: close: $!\n"
;
return
;
}
$self
->{scratch} =
$scratch
;
}
$self
->_flush;
}
sub
_unpack {
my
(
$self
) =
@_
;
my
$ref
=
ref
$self
->{buffer};
return
delete
$self
->{buffer}
if
$ref
eq
''
;
my
$data
;
if
(
$ref
eq
'ARRAY'
) {
$data
=
shift
@{
$self
->{buffer} };
}
elsif
(
$ref
eq
'CODE'
) {
$data
=
$self
->{buffer}->();
}
else
{
confess
"$self->{name}: API error\n"
;
}
$data
.=
defined
$\ ? $\ :
"\n"
if
defined
$data
;
return
$data
;
}
sub
_flush {
my
(
$self
) =
@_
;
return
unless
length
$self
->{scratch};
my
$handle
=
$self
->{
pipe
};
my
$rc
=
$handle
->
syswrite
(
$self
->{scratch} );
if
( not
defined
$rc
) {
confess
"$self->{name}: syswrite: $!\n"
if
$! != EWOULDBLOCK;
}
else
{
substr
(
$self
->{scratch}, 0,
$rc
) =
''
;
}
}
1
__END__
=head1 NAME
Proc::Hevy::Writer - A writer pipe implementation for Proc::Hevy
=head1 DESCRIPTION
C<Proc::Hevy::Writer> implements a writer pipe that
writes data to a child process from a provided buffer. This
is used when writing to a child process's C<STDIN>.
=head1 INTERFACE
=over 2
=item B<new( $name, $buffer )>
Creates a new C<Proc::Hevy::Writer> object. C<$name>
is a symbolic name for the writer. C<$buffer> is the source
mechanism to used for data written to the child process. It
can either be a simple scalar, an C<ARRAY> reference, a C<CODE>
reference or a C<GLOB> reference.
=item B<child( $handle )>
Performs actions suitable when running as part of the child
process. This includes re-opening the provided C<$handle>
to a filehandle that is created based on the type of source
buffer configured in C<new()>. If no buffer was configured,
C<'/dev/null'> is opened for reading.
=item B<parent( $select )>
Performs actions suitable when running as part of the parent
process. This includes adding filehandles to the provided
C<$select> object that should be monitored for writability.
=item B<write>
Performs the actual write to the child process consuming
data from the source buffer configured in C<new()>. When
the source buffer is empty, applicable filehandles are
closed and removed from the select object used in the call
to C<parent()>. Any system errors are considered fatal.
=back
=head1 BUGS
None are known at this time, but if you find one, please feel free
to submit a report to the author.
=head1 AUTHOR
jason hord E<lt>pravus@cpan.orgE<gt>
=head1 SEE ALSO
=over 2
=item L<Proc::Hevy>
=back
=head1 COPYRIGHT
Copyright (c) 2009, jason hord
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
=cut