Ns conn - Revision history

Akhassin at 00:59, 18 June 2010

2010-06-18T00:59:25Z

Akhassin at 00:57, 18 June 2010

2010-06-18T00:57:34Z

Akhassin at 02:45, 11 October 2009

2009-10-11T02:45:55Z

Akhassin at 02:44, 11 October 2009

2009-10-11T02:44:09Z

Akhassin at 02:26, 11 October 2009

2009-10-11T02:26:22Z

Akhassin at 01:49, 11 October 2009

2009-10-11T01:49:59Z

Akhassin at 01:49, 11 October 2009

2009-10-11T01:49:27Z

Akhassin at 01:45, 11 October 2009

2009-10-11T01:45:24Z

Akhassin at 01:43, 11 October 2009

2009-10-11T01:43:49Z

Akhassin at 01:42, 11 October 2009

2009-10-11T01:42:15Z

@@ Line 160: / Line 160: @@
 * '''ns_conn times'''
-: New in 4.5.2: Returns a map (list in array get format) with ''accept'', ''read', ''ready'', ''queue'', ''run'' and ''close'' timestamps in ns_time get format for the current connection.  ''queue'' is the same as what's returned by ns_conn start.  ''accept'' is actually the timestamp for the socket accept and so isn't guaranteed to be specific to this particular connection.
+: New in 4.5.2: Returns a map (list in array get format) with ''accept'', ''read'', ''ready'', ''queue'', ''run'' and ''close'' timestamps in ns_time get format for the current connection.  ''queue'' is the same as what's returned by ns_conn start.  ''accept'' is actually the timestamp for the socket accept and so isn't guaranteed to be specific to this particular connection.
 * '''ns_conn urlencoding''' ''?tclencoding?''
@@ Line 220: / Line 220: @@
 : [[ns_getform]], [[ns_queryget]], [[ns_time]]
+----
 [[Category:Core Tcl API]]

← Older revision		Revision as of 00:57, 18 June 2010
Line 157:		Line 157:

	: If code is specified, sets (and returns) the status code that will be used in the HTTP response. If omitted, returns the previously set status or 0 if one has not yet been set. The status code is not used in ns_return* responses but is used by the first call to [[ns_adp_flush]] or [[ns_adp_close]] or in general when an adp file is requested. You can use this to set the status code in an adp designated as a 404 redirect, for example.		: If code is specified, sets (and returns) the status code that will be used in the HTTP response. If omitted, returns the previously set status or 0 if one has not yet been set. The status code is not used in ns_return* responses but is used by the first call to [[ns_adp_flush]] or [[ns_adp_close]] or in general when an adp file is requested. You can use this to set the status code in an adp designated as a 404 redirect, for example.
		+
		+	* '''ns_conn times'''
		+
		+	: New in 4.5.2: Returns a map (list in array get format) with ''accept'', ''read', ''ready'', ''queue'', ''run'' and ''close'' timestamps in ns_time get format for the current connection. ''queue'' is the same as what's returned by ns_conn start. ''accept'' is actually the timestamp for the socket accept and so isn't guaranteed to be specific to this particular connection.

	* '''ns_conn urlencoding''' ''?tclencoding?''		* '''ns_conn urlencoding''' ''?tclencoding?''

@@ Line 180: / Line 180: @@
 * '''ns_conn write_encoded''' ''?0|1?''
-: Gets or Sets the NS_CONN_WRITE_ENCODED flag which is used to tell [[ns_write]] that the content is not binary and is safe to encode.  This option has been removed in NaviServer which automatically detects when trying to ns_write binary content.  Usually, you do not need to call this yourself and you will use [[ns_startcontent]] to set this flag for you instead.  However, in AOLserver 4.5, ns_statcontent's behavior has changed, so it may be convenient to use this option to reimplement ns_startcontent to be backward compatible as follows:
+: Gets or Sets the NS_CONN_WRITE_ENCODED flag which is used to tell [[ns_write]] that the content is not binary and is safe to encode.  This option has been removed in NaviServer which automatically detects when trying to ns_write binary content.  Usually, you do not need to call this yourself and you will use [[ns_startcontent]] to set this flag for you instead.  However, in AOLserver 4.5, ns_startcontent's behavior has changed, so it may be convenient to use this option to reimplement ns_startcontent to be backward compatible as follows:
    if {[ns_info version] >= 4.5} {

@@ Line 11: / Line 11: @@
 '''DESCRIPTION'''
-: This command is used to retrieve various pieces of information about a connection.  For backward compatibility with AOLserver 2.x, ns_conn command can accept an optional deprecated connid argument (i.e. [ns_conn form $connid]).  With the exception of the '''isconnected''' option, ns_conn will throw an error if there is no connection.
+: This command is used to retrieve various pieces of information about a connection.  For backward compatibility with AOLserver 2.x, ns_conn command can accept an optional deprecated connid argument immediately after the option name (i.e. [ns_conn form $connid]).  With the exception of the '''isconnected''' option, ns_conn will throw an error if there is no connection.
 : The legal ''option''s (which may be abbreviated) are:
@@ Line 177: / Line 177: @@
 : Returns the version of the HTTP request. This is usually 1.0 or 1.1.
 '''EXAMPLES'''

@@ Line 100: / Line 100: @@
 : Returns the host part of the URL in the HTTP request.
 * '''ns_conn isconnected'''
@@ Line 121: / Line 125: @@
 : Returns the IP address of the client, i.e. the "other side" of the HTTP connection. The IP address is returned in the form of a string separated with periods (e.g., 155.164.59.75).
 * '''ns_conn port'''
@@ Line 136: / Line 141: @@
 : Returns the HTTP request line as presented by the client, e.g. GET / HTTP/1.1.
 * '''ns_conn start'''
@@ Line 145: / Line 154: @@
 : Returns the underlying socket for the connection.
-* '''ns_conn urlencoding'''
+* '''ns_conn status''' ''?code?''
-: Returns the [http://www.tcl.tk/man/tcl8.4/TclCmd/encoding.htm TCL-encoding] for the connection which is used to convert input forms to proper UTF.
+: Returns the [http://www.tcl.tk/man/tcl8.4/TclCmd/encoding.htm TCL-encoding] for the connection which is used to convert input forms and query strings to proper UTF.  Or if tclencoding is specified, changes the encoding that will be used by subsequent calls to ns_conn form, etc.  If you previously used [[ns_getform]] or [[ns_getformfile]] for processing multipart file upload submissions (which you can determine with [[ns_isformcached]], after changing the encoding, you should call [[ns_resetcachedform]].  Alternatively, use the [[ns_urlcharset]] wrapper to set the urlencoding from a mime charset (as opposed to a tclencoding) and it will call it for you.
 * '''ns_conn url'''
@@ Line 157: / Line 170: @@
 : Returns the number of elements (delimited by `/') in the URL of the HTTP request.
-* '''ns_conn urlv'''
+* '''ns_conn urlv''' ''?index?''
-: Returns a list containing the pieces of the URL delimited by `/'.
+: Returns a list containing the pieces of the URL delimited by `/' or if ''index'' is specified, returns only the ''index''th element of that list.  Only integer indexes are supported, 'end' is not.
 * '''ns_conn version'''

@@ Line 75: / Line 75: @@
   set NS_CONN_SENTHDRS	   0x10
   set NS_CONN_KEEPALIVE	   0x20
-  set NS_CONN_WRITE_ENCODED 0x40
+  set NS_CONN_WRITE_ENCODED  0x40
-  set NS_CONN_FILECONTENT   0x80
+  set NS_CONN_FILECONTENT    0x80
-  set NS_CONN_RUNNING       0x100
+  set NS_CONN_RUNNING        0x100
   set NS_CONN_OVERFLOW	   0x200
   set NS_CONN_TIMEOUT	   0x400

@@ Line 68: / Line 68: @@
 * '''ns_conn flags'''
-: Returns the decimal value of the current conn flags, which can have one or more of the following values:
+: Returns the decimal value of the current conn flags, which can have one or more of the following values (AOLserver 4.5+):
-  set NS_CONN_CLOSED		  0x1
+  set NS_CONN_CLOSED	   0x1
-  set NS_CONN_SKIPHDRS	  0x2
+  set NS_CONN_SKIPHDRS	   0x2
-  set NS_CONN_SKIPBODY	  0x4
+  set NS_CONN_SKIPBODY	   0x4
-  set NS_CONN_READHDRS	  0x8
+  set NS_CONN_READHDRS	   0x8
-  set NS_CONN_SENTHDRS	  0x10
+  set NS_CONN_SENTHDRS	   0x10
-  set NS_CONN_KEEPALIVE	  0x20
+  set NS_CONN_KEEPALIVE	   0x20
-  set NS_CONN_WRITE_ENCODED     0x40
+  set NS_CONN_WRITE_ENCODED 0x40
-  set NS_CONN_FILECONTENT       0x80
+  set NS_CONN_FILECONTENT   0x80
-  set NS_CONN_RUNNING           0x100
+  set NS_CONN_RUNNING       0x100
-  set NS_CONN_OVERFLOW	  0x200
+  set NS_CONN_OVERFLOW	   0x200
-  set NS_CONN_TIMEOUT	       	  0x400
+  set NS_CONN_TIMEOUT	   0x400
-  set NS_CONN_GZIP		  0x800
+  set NS_CONN_GZIP	   0x800
-  set NS_CONN_CHUNK		  0x1000
+  set NS_CONN_CHUNK	   0x1000
 * '''ns_conn form'''

@@ Line 69: / Line 69: @@
 : Returns the decimal value of the current conn flags, which can have one or more of the following values:
-:** test
+:* NS_CONN_CLOSED		  0x1
-:** test
+:* NS_CONN_SKIPHDRS	  0x2
 * '''ns_conn form'''

← Older revision		Revision as of 01:42, 11 October 2009
Line 65:		Line 65:

	: These four options are mostly for internal use by [[ns_getform]] and [[ns_getformfile]] for processing multi-part form submissions (i.e. browser file uploads)		: These four options are mostly for internal use by [[ns_getform]] and [[ns_getformfile]] for processing multi-part form submissions (i.e. browser file uploads)
		+
		+	* '''ns_conn flags'''
		+
		+	: Returns the decimal value of the current conn flags, which can have one or more of the following values:
		+	:** test
		+	:** test

	* '''ns_conn form'''		* '''ns_conn form'''