rest - Ticket [0880cb441c] - EF - New option -timeout.

Version bumped to 1.7.

Author: andreas-kupries

embedded/md/tcllib/files/modules/rest/rest.md

@@ -1,7 +1,7 @@
 
 [//000000001]: # (rest \- A framework for RESTful web services)
 [//000000002]: # (Generated from file 'rest\.man' by tcllib/doctools with format 'markdown')
-[//000000003]: # (rest\(n\) 1\.6 tcllib "A framework for RESTful web services")
+[//000000003]: # (rest\(n\) 1\.7 tcllib "A framework for RESTful web services")
 
 <hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> &#124; <a
 href="../../../toc.md">Table Of Contents</a> &#124; <a
@@ -39,7 +39,7 @@ rest \- define REST web APIs and call them inline or asychronously
 # <a name='synopsis'></a>SYNOPSIS
 
 package require Tcl 8\.5 9  
-package require rest ?1\.6?  
+package require rest ?1\.7?  
 
 [__::rest::simple__ *url* *query* ?*config*? ?*body*?](#1)  
 [__::rest::get__ *url* *query* ?*config*? ?*body*?](#2)  
@@ -108,6 +108,8 @@ or process the returned data yourself
 
       * __method__
 
+      * __timeout__
+
     Two quick examples:
 
     Example 1, Yahoo Boss:
@@ -467,6 +469,13 @@ Example, Yahoo Weather:
 
         See __callback__ above for more information\.
 
+      * __timeout__
+
+        The value of this option determines whether to set a timeout on the HTTP
+        call\. By default, no timeout is set\.
+
+        Timeout value is accepted in milliseconds\.
+
 # <a name='section4'></a>Examples
 
 Yahoo Geo:

idoc/man/files/modules/rest/rest.n

@@ -1,7 +1,7 @@
 '\"
 '\" Generated from file 'rest\&.man' by tcllib/doctools with format 'nroff'
 '\"
-.TH "rest" n 1\&.6 tcllib "A framework for RESTful web services"
+.TH "rest" n 1\&.7 tcllib "A framework for RESTful web services"
 .\" The -*- nroff -*- definitions below are for supplemental macros used
 .\" in Tcl/Tk manual entries.
 .\"
@@ -275,7 +275,7 @@ rest \- define REST web APIs and call them inline or asychronously
 .SH SYNOPSIS
 package require \fBTcl 8\&.5 9\fR
 .sp
-package require \fBrest ?1\&.6?\fR
+package require \fBrest ?1\&.7?\fR
 .sp
 \fB::rest::simple\fR \fIurl\fR \fIquery\fR ?\fIconfig\fR? ?\fIbody\fR?
 .sp
@@ -357,6 +357,8 @@ The \fIconfig\fR dictionary supports the following keys
 \fBheaders\fR
 .TP
 \fBmethod\fR
+.TP
+\fBtimeout\fR
 .RE
 .sp
 Two quick examples:
@@ -708,6 +710,12 @@ when encountering an HTTP error, or not\&. The default is to not return
 the response body on error\&.
 .sp
 See \fBcallback\fR above for more information\&.
+.TP
+\fBtimeout\fR
+The value of this option determines whether to set a timeout on the HTTP
+call\&. By default, no timeout is set\&.
+.sp
+Timeout value is accepted in milliseconds\&.
 .RE
 .PP
 .SH EXAMPLES

idoc/www/tcllib/files/modules/rest/rest.html

@@ -107,7 +107,7 @@
 &#124; <a href="../../../../toc2.html">Applications</a>
  ] <hr>
 <div class="doctools">
-<h1 class="doctools_title">rest(n) 1.6 tcllib &quot;A framework for RESTful web services&quot;</h1>
+<h1 class="doctools_title">rest(n) 1.7 tcllib &quot;A framework for RESTful web services&quot;</h1>
 <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2>
 <p>rest - define REST web APIs and call them inline or asychronously</p>
 </div>
@@ -129,7 +129,7 @@ <h1 class="doctools_title">rest(n) 1.6 tcllib &quot;A framework for RESTful web
 <div class="doctools_synopsis">
 <ul class="doctools_requirements">
 <li>package require <b class="pkgname">Tcl 8.5 9</b></li>
-<li>package require <b class="pkgname">rest <span class="opt">?1.6?</span></b></li>
+<li>package require <b class="pkgname">rest <span class="opt">?1.7?</span></b></li>
 </ul>
 <ul class="doctools_syntax">
 <li><a href="#1"><b class="cmd">::rest::simple</b> <i class="arg">url</i> <i class="arg">query</i> <span class="opt">?<i class="arg">config</i>?</span> <span class="opt">?<i class="arg">body</i>?</span></a></li>
@@ -200,6 +200,8 @@ <h1 class="doctools_title">rest(n) 1.6 tcllib &quot;A framework for RESTful web
 <dd></dd>
 <dt><b class="const">method</b></dt>
 <dd></dd>
+<dt><b class="const">timeout</b></dt>
+<dd></dd>
 </dl>
 <p>Two quick examples:</p>
 <p>Example 1, Yahoo Boss:</p>
@@ -474,6 +476,10 @@ <h1 class="doctools_title">rest(n) 1.6 tcllib &quot;A framework for RESTful web
 when encountering an HTTP error, or not. The default is to not return
 the response body on error.</p>
 <p>See <b class="const">callback</b> above for more information.</p></dd>
+<dt><b class="const">timeout</b></dt>
+<dd><p>The value of this option determines whether to set a timeout on the HTTP
+call. By default, no timeout is set.</p>
+<p>Timeout value is accepted in milliseconds.</p></dd>
 </dl></dd>
 </dl>
 </div>

modules/rest/pkgIndex.tcl

@@ -1,2 +1,2 @@
 if {![package vsatisfies [package provide Tcl] 8.5 9]} {return}
-package ifneeded rest 1.6 [list source [file join $dir rest.tcl]]
+package ifneeded rest 1.7 [list source [file join $dir rest.tcl]]

modules/rest/rest.man

@@ -1,5 +1,5 @@
 [comment {-*- tcl -*- doctools manpage}]
-[vset VERSION 1.6]
+[vset VERSION 1.7]
 [manpage_begin rest n [vset VERSION]]
 [moddesc   {A framework for RESTful web services}]
 [titledesc {define REST web APIs and call them inline or asychronously}]
@@ -55,6 +55,7 @@ dictionary must be present, however it is allowed to be empty.
 [def [const format]]
 [def [const headers]]
 [def [const method]]
+[def [const timeout]]
 
 [comment {-- TODO -- describe the meaning of the various keys -- }]
 [list_end]
@@ -470,6 +471,14 @@ the response body on error.
 
 [para] See [const callback] above for more information.
 
+[comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@]
+[def [const timeout]]
+
+The value of this option determines whether to set a timeout on the HTTP
+call. By default, no timeout is set.
+
+[para] Timeout value is accepted in milliseconds.
+
 [comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@]
 [list_end]
 

modules/rest/rest.tcl

@@ -10,7 +10,7 @@ package require json
 package require tdom
 package require base64
 
-package provide rest 1.6
+package provide rest 1.7
 
 namespace eval ::rest {
     namespace export create_interface parameters parse_opts save \
@@ -470,6 +470,9 @@ proc ::rest::_call {callback headers url query body error_body} {
     if {$callback != ""} {
         lappend opts -command [list ::rest::_callback {*}$callback]
     }
+    if {[dict exists $config timeout]} {
+        lappend opts -timeout [dict get $config timeout]
+    }
 
     #puts "headers $headers"
     #puts "opts $opts"