lib/PublicInbox/GetlineBody.pm

   1 # Copyright (C) 2016-2018 all contributors <meta@public-inbox.org>
   2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
   3
   4 # Wrap a pipe or file for PSGI streaming response bodies and calls the
   5 # end callback when the object goes out-of-scope.
   6 # This depends on rpipe being _blocking_ on getline.
   7 #
   8 # public-inbox-httpd favors "getline" response bodies to take a
   9 # "pull"-based approach to feeding slow clients (as opposed to a
  10 # more common "push" model)
  11 package PublicInbox::GetlineBody;
  12 use strict;
  13 use warnings;
  14
  15 sub new {
  16         my ($class, $rpipe, $end, $buf) = @_;
  17         bless { rpipe => $rpipe, end => $end, buf => $buf }, $class;
  18 }
  19
  20 # close should always be called after getline returns undef,
  21 # but a client aborting a connection can ruin our day; so lets
  22 # hope our underlying PSGI server does not leak references, here.
  23 sub DESTROY { $_[0]->close }
  24
  25 sub getline {
  26         my ($self) = @_;
  27         my $buf = delete $self->{buf}; # initial buffer
  28         defined $buf ? $buf : $self->{rpipe}->getline;
  29 }
  30
  31 sub close {
  32         my ($self) = @_;
  33         my $rpipe = delete $self->{rpipe};
  34         close $rpipe if $rpipe;
  35         my $end = delete $self->{end};
  36         $end->() if $end;
  37 }
  38
  39 1;