.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "LWP::UserAgent::Role::CHICaching::SimpleMungeResponse 3pm"
.TH LWP::UserAgent::Role::CHICaching::SimpleMungeResponse 3pm "2022-05-28" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
LWP::UserAgent::Role::CHICaching::SimpleMungeResponse \- A role to manipulate the response when caching
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
See LWP::UserAgent::Role::CHICaching.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
When caching, it is sometimes useful to change the response, in
particular the body in some way for caching. In some cases, you might
not want to store the entire body, but compress it in some way, or
store the data in a different data structure than the serialized
version shared over the network.
.PP
The methods here are used to first manipulate the response before it
is sent to the cache, and then a cached response before it is returned
to the client.
.SS "Methods"
.IX Subsection "Methods"
.ie n .IP """cache_set($response, $expires_in)""" 4
.el .IP "\f(CWcache_set($response, $expires_in)\fR" 4
.IX Item "cache_set($response, $expires_in)"
A method that takes the HTTP::Response from the client and an
expires time in seconds and set the actual cache. This role's
implementation stores the response as it is.
.ie n .IP """finalize($cached)""" 4
.el .IP "\f(CWfinalize($cached)\fR" 4
.IX Item "finalize($cached)"
A method that takes the cached entry as an argument, and will return a
HTTP::Response to return to the client. This implementation returns
the response directly from the cache.
.SH "TODO"
.IX Header "TODO"
The standard has a \f(CW\*(C`no\-transform\*(C'\fR directive that is relevant to this,
since roles such as this can be used to transform the response. This
needs to be dealt with.
.SH "AUTHOR"
.IX Header "AUTHOR"
Kjetil Kjernsmo <kjetilk@cpan.org>.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2016 by Kjetil Kjernsmo.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.