]> Sergey Matveev's repositories - public-inbox.git/commitdiff
httpd/async + qspawn: rename {fh} fields
authorEric Wong <e@80x24.org>
Fri, 23 Dec 2022 11:05:15 +0000 (11:05 +0000)
committerEric Wong <e@80x24.org>
Fri, 23 Dec 2022 12:44:26 +0000 (12:44 +0000)
Use more unique names within the project to minimize confusion
since these packages interact quite a bit and using identical
names leads to needless confusion.

lib/PublicInbox/HTTPD/Async.pm
lib/PublicInbox/Qspawn.pm

index 75b3bd50e9a0ddeecee96fdf862d21ce92c00528..e03daafac8d1a7994042fa52e94e4eac60f7ac4c 100644 (file)
@@ -37,7 +37,7 @@ sub new {
                arg => $arg, # arg for $cb
                end_obj => $end_obj, # like END{}, can ->event_step
        }, $class;
-       my $pp = tied *$io;
+       my $pp = tied *$io; # ProcessPipe
        $pp->{fh}->blocking(0) // die "$io->blocking(0): $!";
        $self->SUPER::new($io, EPOLLIN);
 }
@@ -54,7 +54,7 @@ sub event_step {
                # and 65536 is the default Linux pipe size
                my $r = sysread($sock, my $buf, 65536);
                if ($r) {
-                       $self->{fh}->write($buf); # may call $http->close
+                       $self->{ofh}->write($buf); # may call $http->close
                        # let other clients get some work done, too
                        return if $http->{sock}; # !closed
 
@@ -63,7 +63,7 @@ sub event_step {
                        return; # EPOLLIN means we'll be notified
                }
 
-               # Done! Error handling will happen in $self->{fh}->close
+               # Done! Error handling will happen in $self->{ofh}->close
                # called by end_obj->event_step handler
                delete $http->{forward};
                $self->close; # queues end_obj->event_step to be called
@@ -71,9 +71,11 @@ sub event_step {
 }
 
 # once this is called, all data we read is passed to the
-# to the PublicInbox::HTTP instance ($http) via $fh->write
+# to the PublicInbox::HTTP instance ($http) via $ofh->write
+# $ofh is typically PublicInbox::HTTP::{Chunked,Identity}, but
+# may be PublicInbox::GzipFilter or $PublicInbox::Qspawn::qx_fh
 sub async_pass {
-       my ($self, $http, $fh, $bref) = @_;
+       my ($self, $http, $ofh, $bref) = @_;
        # In case the client HTTP connection ($http) dies, it
        # will automatically close this ($self) object.
        $http->{forward} = $self;
@@ -82,10 +84,10 @@ sub async_pass {
        # This is typically PublicInbox:HTTP::{chunked,identity}_wcb,
        # but may be PublicInbox::GzipFilter::write.  PSGI requires
        # *_wcb methods respond to ->write (and ->close), not ->print
-       $fh->write($$bref);
+       $ofh->write($$bref);
 
        $self->{http} = $http;
-       $self->{fh} = $fh;
+       $self->{ofh} = $ofh;
 }
 
 # may be called as $forward->close in PublicInbox::HTTP or EOF (event_step)
index da7cd74fe8cb1628f6884b36d29b61c9c230ea7e..6e24538959517b00ec1179f87318a9d875ab3db8 100644 (file)
@@ -187,7 +187,7 @@ sub event_step {
        my ($self, $err) = @_; # $err: $!
        warn "psgi_{return,qx} $err" if defined($err);
        finish($self);
-       my ($fh, $qx_fh) = delete(@$self{qw(fh qx_fh)});
+       my ($fh, $qx_fh) = delete(@$self{qw(qfh qx_fh)});
        $fh->close if $fh; # async-only (psgi_return)
 }
 
@@ -242,7 +242,7 @@ sub psgi_return_init_cb {
                # done reading headers, handoff to read body
                my $fh = $wcb->($r); # scalar @$r == 2
                $fh = $filter->attach($fh) if $filter;
-               $self->{fh} = $fh;
+               $self->{qfh} = $fh;
                $async->async_pass($env->{'psgix.io'}, $fh,
                                        delete($self->{hdr_buf}));
        } else { # for synchronous PSGI servers