diff options
| author | Jeremy Harris <jgh146exb@wizmail.org> | 2020-04-18 15:36:54 +0100 |
|---|---|---|
| committer | Jeremy Harris <jgh146exb@wizmail.org> | 2020-04-22 19:27:27 +0100 |
| commit | 1950cf85b47f7c8407b3318a4f8fc57c0af6d6ba (patch) | |
| tree | 205c52910616b408c0c110b3c187414cc8ca5db5 /doc | |
| parent | accf9211ea33262b8865805a4f61155f26320444 (diff) | |
readsocket expansion: response caching
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/doc-docbook/spec.xfpt | 36 | ||||
| -rw-r--r-- | doc/doc-txt/NewStuff | 5 |
2 files changed, 30 insertions, 11 deletions
diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index c54437181..870248570 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -10285,21 +10285,37 @@ ${readsocket{/socket/name}{request string}{3s}} .endd The third argument is a list of options, of which the first element is the timeout -and must be present if the argument is given. +and must be present if any options are given. Further elements are options of form &'name=value'&. -Two option types is currently recognised: shutdown and tls. -The first defines whether (the default) -or not a shutdown is done on the connection after sending the request. -Example, to not do so (preferred, eg. by some webservers): +Example: .code ${readsocket{/socket/name}{request string}{3s:shutdown=no}} .endd -The second, tls, controls the use of TLS on the connection. Example: -.code -${readsocket{/socket/name}{request string}{3s:tls=yes}} -.endd -The default is to not use TLS. + +.new +The following option names are recognised: +.ilist +&*cache*& +Defines if the result data can be cached for use by a later identical +request in the same process. +Values are &"yes"& or &"no"& (the default). +If not, all cached results for this connection specification +will be invalidated. + +.next +&*shutdown*& +Defines whether or not a write-shutdown is done on the connection after +sending the request. Values are &"yes"& (the default) or &"no"& +(preferred, eg. by some webservers). + +.next +&*tls*& +Controls the use of TLS on the connection. +Values are &"yes"& or &"no"& (the default). If it is enabled, a shutdown as descripbed above is never done. +.endlist +.wen + A fourth argument allows you to change any newlines that are in the data that is read, in the same way as for &%readfile%& (see above). This example diff --git a/doc/doc-txt/NewStuff b/doc/doc-txt/NewStuff index f922f2cf4..4ae49c2fa 100644 --- a/doc/doc-txt/NewStuff +++ b/doc/doc-txt/NewStuff @@ -54,7 +54,10 @@ Version 4.94 14. Options on pgsql and mysql lookups, to specify server separate from the lookup string. -15. Expansion item ${listquote {<char} {<item>}} +15. Expansion item ${listquote {<char} {<item>}}. + +16. An option for the ${readsocket {}{}{}} expansion to make the result data + cacheable. |