logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

HTTP::Server::Simple::Recorder - Mixin to record HTTP::Server::Simple's sockets

Author

       David Glasser  "<glasser@bestpractical.com>"

Bugs And Limitations

       No bugs have been reported.

       Please report any bugs or feature requests to "bug-http-server-simple-recorder@rt.cpan.org", or through
       the web interface at <http://rt.cpan.org>.

Dependencies

       IO::Tee, HTTP::Server::Simple.

Description

       This module allows you to record all HTTP communication between an HTTP::Server::Simple-derived server
       and its clients.  It is a mixin, so it doesn't itself subclass HTTP::Server::Simple; you need to subclass
       from both HTTP::Server::Simple::Recorder and an actual HTTP::Server::Simple subclass, and
       HTTP::Server::Simple::Recorder should be listed first.

       Every time a client connects to your server, this module will open a pair of files and log the
       communication between the file and server to these files.  Each connection gets a serial number starting
       at 1.  The filename used is "<$self-"recorder_prefix>>, then a period, then the connection serial number,
       then a period, then either "in" or "out".  "recorder_prefix" defaults to
       "/tmp/http-server-simple-recorder", but you can override that in your subclass.  For example, you might
       want to include the process ID.

Disclaimer Of Warranty

       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT
       PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
       PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
       INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
       PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE
       SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY
       OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
       THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
       RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE
       WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
       DAMAGES.

perl v5.38.2                                       2024-03-06                HTTP::Server::Simple::Recorder(3pm)

Name

       HTTP::Server::Simple::Recorder - Mixin to record HTTP::Server::Simple's sockets

See Also

       HTTP::Server::Simple, HTTP::Recorder.

Synopsis

           package MyServer;
           use base qw/HTTP::Server::Simple::Recorder HTTP::Server::Simple::CGI/;

           sub recorder_prefix { "path/to/logs/record" }  # defaults to /tmp/http-server-simple-recorder

           # logs to path/to/logs/record.34244.1.in,
           #         path/to/logs/record.34244.1.out,
           #         path/to/logs/record.34244.2.in,
           #         path/to/logs/record.34244.2.out, etc, if 34244 is the PID of the server

See Also