Tcl API Reference -- ns_conn

### ns_conn

#### Overview

Find information about the current HTTP connection.

#### Syntax

ns_conn authpassword

ns_conn authuser

ns_conn close

ns_conn contentlength

ns_conn driver

ns_conn form

ns_conn headers

ns_conn host

ns_conn isconnected

ns_conn location

ns_conn method

ns_conn outputheaders

ns_conn peeraddr

ns_conn port

ns_conn protocol

ns_conn query

ns_conn request

ns_conn url

ns_conn urlc

ns_conn urlv

ns_conn version

#### Description

ns_conn authpassword returns the decoded user password from the authorization data.

ns_conn authuser returns the decoded user name from the authorization data.

ns_conn close closes the connection so the script (or ADP) can do any time-consuming processing without making the client wait. If you use ns_conn close in an ADP, streaming should be turned on before closing the connection (i.e. <script runat=server stream=on>) or nothing will get sent out at all!

ns_conn contentlength returns the number of bytes in the content passed in.

ns_conn driver returns the name of the module (nssock or nsssl) that is acting as the communications driver for this connection.

ns_conn form returns any submitted form data as an ns_set. This form data may have been submitted with a POST or appended to the URL in a GET request.

ns_conn headers returns any header data as an ns_set where the keys are the field names. The case of the returned field names depends on the HeaderCase configuration parameter. By default, HeaderCase is "Preserve", which means case is preserved.

ns_conn host returns the host part of the URL in the HTTP request.

ns_conn isconnected returns 1 if you're in a connection thread, and you are therefore allowed to make calls to ns_conn. It returns 0 if you're not in a connection thread (such as when you're in a schedule procedure) and you are not allowed to make calls to ns_conn.

ns_conn location returns the location string for this virtual server in the form `protocol://hostname[:port]`.

ns_conn method returns the HTTP method.

ns_conn outputheaders returns the set of headers that will be sent out when a result is returned to the client. You can also use this command to write to the set of output headers. For example:

        ns_set put [ns_conn outputheaders] key value

ns_conn peeraddr returns the IP address of 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 returns the port specified explicitly in the URL of the HTTP request. If the browser does not explicity send the ":port" part of the URL, the port number returned will be 0.

ns_conn protocol returns the protocol of the URL in the HTTP request (usually unspecified)

ns_conn query returns any query data that was part of the HTTP request.

ns_conn request returns the HTTP request line.

ns_conn url returns the URL of the HTTP request.

ns_conn urlc returns the number of elements (delimited by `/') in the URL of the HTTP request.

ns_conn urlv returns a list containing the pieces of the URL delimited by `/'.

ns_conn version returns the version of the HTTP request. This is usually 0.9 or 1.0.

Top of Page
Copyright © 1998-99 America Online, Inc.