summaryrefslogtreecommitdiffstats
path: root/doc/http.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/http.n')
-rw-r--r--doc/http.n15
1 files changed, 13 insertions, 2 deletions
diff --git a/doc/http.n b/doc/http.n
index 7fd61ce..b4f1b1e 100644
--- a/doc/http.n
+++ b/doc/http.n
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: http.n,v 1.3 1999/04/16 00:46:35 stanton Exp $
+'\" RCS: @(#) $Id: http.n,v 1.4 1999/06/30 17:46:51 welch Exp $
'\"
.so man.macros
.TH "Http" n 8.0 Tcl "Tcl Built-In Commands"
@@ -32,6 +32,8 @@ Http \- Client-side implementation of the HTTP/1.0 protocol.
\fB::http::code \fItoken\fR
.sp
\fB::http::data \fItoken\fR
+.sp
+\fB::http::cleanup \fItoken\fR
.BE
.SH DESCRIPTION
@@ -243,6 +245,13 @@ state array.
\fB::http::size\fP \fItoken\fP
This is a convenience procedure that returns the \fBcurrentsize\fP
element of the state array.
+.TP
+\fB::http::cleanup\fP \fItoken\fP
+This procedure cleans up the state associated with the connection
+identified by \fItoken\fP. After this call, the procedures
+like \fB::http::data\fP cannot be used to get information
+about the operation.
+
.SH "STATE ARRAY"
The \fB::http::geturl\fR procedure returns a \fItoken\fR that can be used to
get to the state of the HTTP transaction in the form of a Tcl array.
@@ -251,7 +260,9 @@ Use this construct to create an easy-to-use array variable:
upvar #0 $token state
.CE
Once the data associated with the url is no longer needed, the state
-array should be unset to free up storage. The following elements of
+array should be unset to free up storage.
+The \fBhttp::cleanup\fP procedure is provided for that purpose.
+The following elements of
the array are supported:
.RS
.TP