Changeset 15029 in project


Ignore:
Timestamp:
06/19/09 01:38:21 (10 years ago)
Author:
sjamaan
Message:

Document some parameters

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/http-client

    r15028 r15029  
    7878</example>
    7979
     80==== Parameters
     81
     82<parameter>(max-retry-attempts [number])</parameter>
     83
     84When a request fails because of an I/O or network problem (or simply
     85because the remote end closed a persistent connection while we were
     86doing something else), the library will try to establish a new
     87connection and perform the request again.  This parameter controls how
     88many times this is allowed to be done.  If {{#f}}, it will never give up.
     89
     90Defaults to 1.
     91
     92<parameter>(retry-request? [predicate])</procedure>
     93
     94This procedure is invoked when a retry should take place, to determine
     95if it should take place at all.  It should be a procedure accepting a
     96request object and returning {{#f}} or a true value.  If the value is
     97true, the new request will be sent.  Otherwise, the error that caused
     98the retry attempt will be re-raised.
     99
     100Defaults to {{idempotent?}}, from [[intarweb]].  This is because
     101non-idempotent requests cannot be safely retried when it is unknown
     102whether the previous request reached the server or not.
     103
     104<parameter>(max-redirect-depth [number])</procedure>
     105
     106The maximum number of allowed redirects, or {{#f}} if there is no
     107limit.  Currently there's no automatic redirect loop detection
     108algorithm implemented.
     109
     110Defaults to 5.
     111
     112<parameter>(client-software [software-spec])</procedure>
     113
     114This is the names, versions and comments of the software packages that
     115the client is using, for use in the {{user-agent}} header which is
     116automatically added to each request.
     117
     118Defaults to {{(("Chicken Scheme HTTP-client" VERSION #f))}}, where
     119{{VERSION}} is the version of this egg.
     120
     121==== Connection management
     122
     123TODO
     124
    80125=== Changelog
    81126
Note: See TracChangeset for help on using the changeset viewer.