.\" 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::SimpleKeyGen 3pm"
.TH LWP::UserAgent::Role::CHICaching::SimpleKeyGen 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::SimpleKeyGen \- A role for cache keys when caching LWP::UserAgent
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
See LWP::UserAgent::Role::CHICaching.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
LWP::UserAgent::Role::CHICaching is a role for creating caching
user agents. There's some complexity around caching different variants
of the same resource (e.g. the same thing in different natural
languages, different serializations that is considered in Section
4.1 of \s-1RFC7234\s0 <http://tools.ietf.org/html/rfc7234#section-4.1> that
this role is factored out to address in the dumbest way possible: Just
don't cache when the problem arises.
.PP
To really solve this problem in a better way, you need to generate a
cache key based on not only the \s-1URI,\s0 but also on the content
(e.g. \f(CW\*(C`Content\-Language: en\*(C'\fR), and so, provide a better
implementation of the \f(CW\*(C`key\*(C'\fR attribute, and then, you also need to
tell the system when it is \s-1OK\s0 to cache something with a \f(CW\*(C`Vary\*(C'\fR header
by making the \f(CW\*(C`cache_vary\*(C'\fR method smarter. See
LWP::UserAgent::Role::CHICaching::VaryNotAsterisk for an example of
an alternative.
.SS "Attributes and Methods"
.IX Subsection "Attributes and Methods"
.ie n .IP """key"", ""clear_key""" 4
.el .IP "\f(CWkey\fR, \f(CWclear_key\fR" 4
.IX Item "key, clear_key"
The key to use for a response. This role will return the canonical \s-1URI\s0 of the
request as a string, which is a reasonable default.
.ie n .IP """cache_vary""" 4
.el .IP "\f(CWcache_vary\fR" 4
.IX Item "cache_vary"
Will never allow a response with a \f(CW\*(C`Vary\*(C'\fR header to be cached.
.SH "AUTHOR"
.IX Header "AUTHOR"
Kjetil Kjernsmo <kjetilk@cpan.org>.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2015, 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.