[ViewVC] Diff of: cvs/AnyEvent-HTTP/README

Comparing AnyEvent-HTTP/README (file contents):
Revision 1.27 by root, Sun Aug 28 09:31:29 2016 UTC vs.
Revision 1.28 by root, Mon Apr 27 12:14:12 2020 UTC

             Currently, if your proxy requires authorization, you have to
             specify an appropriate "Proxy-Authorization" header in every
             request.
+            Note that this module will prefer an existing persistent
+            connection, even if that connection was made using another
+            proxy. If you need to ensure that a new connection is made in
+            this case, you can either force "persistent" to false or e.g.
+            use the proxy address in your "sessionid".
         body => $string
             The request body, usually empty. Will be sent as-is (future
             versions of this module might offer more options).
         cookie_jar => $hash_ref
             The default for this option is "low", which could be interpreted
             as "give me the page, no matter what".
             See also the "sessionid" parameter.
-        session => $string
+        sessionid => $string
-            The module might reuse connections to the same host internally.
+            The module might reuse connections to the same host internally
-            Sometimes (e.g. when using TLS), you do not want to reuse
+            (regardless of other settings, such as "tcp_connect" or
-            connections from other sessions. This can be achieved by setting
+            "proxy"). Sometimes (e.g. when using TLS or a specfic proxy),
-            this parameter to some unique ID (such as the address of an
+            you do not want to reuse connections from other sessions. This
-            object storing your state data, or the TLS context) - only
+            can be achieved by setting this parameter to some unique ID
-            connections using the same unique ID will be reused.
+            (such as the address of an object storing your state data or the
+            TLS context, or the proxy IP) - only connections using the same
+            unique ID will be reused.
         on_prepare => $callback->($fh)
             In rare cases you need to "tune" the socket before it is used to
             connect (for example, to bind it on a given IP address). This
             parameter overrides the prepare callback passed to
             AnyEvent::HTTP establishes connections. Normally it uses
             AnyEvent::Socket::tcp_connect to do this, but you can provide
             your own "tcp_connect" function - obviously, it has to follow
             the same calling conventions, except that it may always return a
             connection guard object.
+            The connections made by this hook will be treated as equivalent
+            to connections made the built-in way, specifically, they will be
+            put into and taken from the persistent connection cache. If your
+            $tcp_connect function is incompatible with this kind of re-use,
+            consider switching off "persistent" connections and/or providing
+            a "sessionid" identifier.
             There are probably lots of weird uses for this function,
             starting from tracing the hosts "http_request" actually tries to
             connect, to (inexact but fast) host => IP address caching or
             even socks protocol support.
         persistent => $boolean
             Try to create/reuse a persistent connection. When this flag is
             set (default: true for idempotent requests, false for all
             others), then "http_request" tries to re-use an existing
-            (previously-created) persistent connection to the host and,
+            (previously-created) persistent connection to same host (i.e.
+            identical URL scheme, hostname, port and sessionid) and, failing
-            failing that, tries to create a new one.
+            that, tries to create a new one.
             Requests failing in certain ways will be automatically retried
             once, which is dangerous for non-idempotent requests, which is
             why it defaults to off for them. The reason for this is because
             the bozos who designed HTTP/1.1 made it impossible to
             distinguish between a fatal error and a normal connection
             timeout, so you never know whether there was a problem with your
             request or not.
             When reusing an existent connection, many parameters (such as
-            TLS context) will be ignored. See the "session" parameter for a
+            TLS context) will be ignored. See the "sessionid" parameter for
-            workaround.
+            a workaround.
         keepalive => $boolean
             Only used when "persistent" is also true. This parameter decides
             whether "http_request" tries to handshake a HTTP/1.0-style
             keep-alive connection (as opposed to only a HTTP/1.1 persistent
         A cookie jar is initially an empty hash-reference that is managed by
         this module. Its format is subject to change, but currently it is as
         follows:
-        The key "version" has to contain 1, otherwise the hash gets emptied.
+        The key "version" has to contain 2, otherwise the hash gets cleared.
         All other keys are hostnames or IP addresses pointing to
         hash-references. The key for these inner hash references is the
         server path for which this cookie is meant, and the values are again
         hash-references. Each key of those hash-references is a cookie name,
         and the value, you guessed it, is another hash-reference, this time
         Here is an example of a cookie jar with a single cookie, so you have
         a chance of understanding the above paragraph:
            {
-              version    => 1,
+              version    => 2,
               "10.0.0.1" => {
                  "/" => {
                     "mythweb_id" => {
                       _expires => 1293917923,
                       value    => "ooRung9dThee3ooyXooM1Ohm",

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent-HTTP/README (file contents): Revision 1.27 by root, Sun Aug 28 09:31:29 2016 UTC vs. Revision 1.28 by root, Mon Apr 27 12:14:12 2020 UTC

Diff Legend

Comparing AnyEvent-HTTP/README (file contents):
Revision 1.27 by root, Sun Aug 28 09:31:29 2016 UTC vs.
Revision 1.28 by root, Mon Apr 27 12:14:12 2020 UTC