Ns adp registerproc - Revision history

Akhassin at 08:19, 14 October 2009

2009-10-14T08:19:42Z

Akhassin at 08:15, 14 October 2009

2009-10-14T08:15:55Z

Akhassin at 08:15, 14 October 2009

2009-10-14T08:15:06Z

Akhassin at 07:57, 14 October 2009

2009-10-14T07:57:16Z

Akhassin: Removed contents from ns_register_proc, this is a different command

2009-10-03T23:20:01Z

Removed contents from ns_register_proc, this is a different command

WikiSysop: imported from WiKit id 869

2005-02-16T21:41:43Z

imported from WiKit id 869

New page

Man page: http://aolserver.com/docs/tcl/ns_register_proc.html

----

'''NAME'''

: ns_register_proc - Register a procedure for a method/URL combination

'''SYNOPSIS'''

: '''ns_register_proc''' ''?-noinherit?'' method URL myproc ''?args?''

'''DESCRIPTION'''

: '''ns_register_proc''' registers the procname to handle
: the specified method/URL combination. When the
: server gets a matching request, it calls procname
: with the connection id and any arguments specified
: here.

: If ''-noinherit'' is specified, the requested URL must
: match the specified URL exactly. For example, if
: the URL specified with '''ns_register_proc''' is
: /foo/bar, procname will not be called unless the
: requested URL is exactly /foo/bar.

: If ''-noinherit'' is not specified, the requested URL
: can match the specified URL or any URL below it.
: For example, if the URL specified with '''ns_register_proc'''
: is /foo/bar, procname will be called for
: /foo/bar, /foo/bar/hmm, and any other URL below
: /foo/bar, provided there is not already another
: procedure registered for that exact URL or for an
: URL with a closer match.

: Note that you must use a glob-style matching character
: if you want inheritance for file names. For
: example, if you want /foo/bar to match
: /foo/bar.html, you must use:

ns_register_proc /foo/bar*

: You can register two procedures for any given
: method/URL combination by calling '''ns_register_proc'''
: once with the ''-noinherit'' flag set and once without
: it. Only one of the procedures will be called for
: any given request, depending on whether the URL was
: an exact match or not. For example:

ns_register_proc -noinherit GET /foo/bar Aproc
ns_register_proc GET /foo/bar Bproc
ns_register_proc GET /foo/bar/hmm Cproc

: Aproc will be called when the requested URL is
: exactly /foo/bar. Bproc will be called when the
: requested URL is below /foo/bar, provided there is
: not already another procedure registered to be
: called for that exact URL or for an URL with a
: closer match. Cproc (not Bproc) will be called when
: the requested URL is equal to or below
: /foo/bar/hmm. Syntax for the registered procedure
: The conn (connection) argument is optional for procedures
: registered by ns_register_proc if the procedure has
: 0 or 1 arguments (not including conn).
: The following examples show the variations that can
: be used in this case:

ns_register_proc GET /noargs noargs
ns_register_proc GET /context context fnord
ns_register_proc GET /conncontext conncontext greeblev

proc noargs { } {
ns_returnnotice 200 "noargs"
} ;# noargs

proc context { context } {
ns_returnnotice 200 "context is $context"
} ;# context

proc conncontext { conn context } {
ns_returnnotice 200 "conncontext is $context"
} ;# conncontext

: The conn (connection) argument is required for procedures
: registered by '''ns_register_proc''' if the procedure
: has 2 or more arguments (not including
: conn). The conn argument will be filled automatically
: with the connection information. The first
: argument following conn will always take the value
: supplied by '''ns_register_proc''', if there is one, or
: an empty value. All other arguments must supply a
: default value. The following examples show the
: variations that can be used in this case:

ns_register_proc GET /twoargs twoargs fnord
ns_register_proc GET /threeargs threeargs fnord fjord

ns_register_proc -noinherit GET /foo/bar Aproc
ns_register_proc GET /foo/bar Bproc
ns_register_proc GET /foo/bar/hmm Cproc

: Aproc will be called when the requested URL is
: exactly /foo/bar. Bproc will be called when the
: requested URL is below /foo/bar, provided there is
: not already another procedure registered to be
: called for that exact URL or for an URL with a
: closer match. Cproc (not Bproc) will be called when
: the requested URL is equal to or below
: /foo/bar/hmm. Syntax for the registered procedure
: The conn (connection) argument is optional for procedures
: registered by '''ns_register_proc''' if the procedure
: has 0 or 1 arguments (not including conn).
: The following examples show the variations that can
: be used in this case:

ns_register_proc GET /noargs noargs
ns_register_proc GET /context context fnord
ns_register_proc GET /conncontext conncontext greeble

proc noargs { } {
ns_returnnotice 200 "noargs"
} ;# noargs

proc context { context } {
ns_returnnotice 200 "context is $context"
} ;# context

proc conncontext { conn context } {
ns_returnnotice 200 "conncontext is $context"
} ;# conncontext

: The conn (connection) argument is required for procedures
: registered by ns_register_proc if the procedure has 2
: or more arguments (not including
: conn). The conn argument will be filled automatically
: with the connection information. The first
: argument following conn will always take the value
: supplied by ns_register_proc, if there is one, or
: an empty value. All other arguments must supply a
: default value. The following examples show the
: variations that can be used in this case:

ns_register_proc GET /twoargs twoargs fnord
ns_register_proc GET /threeargs threeargs fnord fjord

proc twoargs { conn context { greeble bork } } {
# Do stuff...
}

proc threeargs { conn context {greeble bork } { hoover quark } {
# Do stuff...
}

: When a GET of /twoargs is requested, the conn argument
: will be filled automatically, the context
: argument will be assigned "fnord" and the greeble
: argument will be assigned the default value "bork".

: When a GET of /threeargs is requested, the conn
: argument will be filled automatically, the context
: argument will be assigned "fnord" and the greeble
: argument will be assigned "fjord", and the hoover
: argument will be assigned the default value
: "quark".

'''SEE ALSO'''

@@ Line 48: / Line 48: @@
      <geturl -timeout=30 -binary=0>http://www.aolserver.com/</geturl>
-: In another example we show how to use a registered tag without an ''endtag''. This tag provides a declarative way of controlling adp parsing parameters and gives safe-parsed adp pages the ability to call ns_adp_ctl:
+: In another example we show how to use a registered tag without an ''endtag''. This tag provides a declarative way of controlling adp parsing parameters and gives safe-parsed adp pages the ability to call [[ns_adp_ctl]]:
      ns_adp_registerproc adpControl adpControlProc

@@ Line 38: / Line 38: @@
          set url [lindex $args end]
          set args [lrange $args 0 end-1]
-         set token [eval ::http::geturl [list $url $args]]
+         set token [eval ::http::geturl [list $url] $args]
          set result [::http::data $token]
          ::http::cleanup $token

@@ Line 30: / Line 30: @@
 '''EXAMPLE'''
-: Suppose you want to register a tag that formats the enclosed text only if it is Christmas. You could register the tag as follows:
+: Suppose you want to register a tag that retrieves some url using the Tcl http package. You could register the tag as follows:
-     ns_adp_registerscript "christmas" "/christmas" xmas
+     ns_adp_registerproc "geturl" "/geturl" geturlproc
      # Note: We are registering a Tcl proc.
-     proc xmas {string args} {
+     proc geturlproc {args} {
-         if {[ns_fmttime [ns_time] "%m/%d"] == "12/25"}  then {
+         set url [lindex $args end]
-            return $string
+        set args [lrange $args 0 end-1]
+        set token [eval ::http::geturl [list $url $args]]
+     }
 : Then, in an ADP, you use these tags:
-     <christmas>Merry Christmas to all, and to all a good night!</christmas>
+     <geturl -timeout=30 -binary=0>http://www.aolserver.com/</geturl>
-: In another example we show how to use a registered tag without an ''endtag''. The tag is registered as follows:
+: In another example we show how to use a registered tag without an ''endtag''. This tag provides a declarative way of controlling adp parsing parameters and gives safe-parsed adp pages the ability to call ns_adp_ctl:
-     ns_adp_registerscript hello helloproc
+     ns_adp_registerproc adpControl adpControlProc
      # Note: We are registering a Tcl proc.
-     proc helloproc { tags } {
+     proc adpControlProc { args } {
-         return "Hello, [ns_set get $tags name]."
+         foreach {option value} $args {
+     }
 : In an ADP, you use this tag:
-     <hello name=Bob>
+     <adpControl nocache=1 gzip=0>
 : This can be extended to provide XML-like template pages for content.
@@ Line 62: / Line 67: @@
 '''SEE ALSO'''
-: [[ns_adp_registerproc]], [[ns_adp_parse]]
+: [[ns_adp_registerscript]], [[ns_adp_parse]]
 [[Category:Documentation]] [[Category:Core Tcl API]]

@@ Line 1: / Line 1: @@
 '''NAME'''
-:       ns_adp_registerproc - Register an ADP tag that invokes a procedure
+: ns_adp_registerproc - Register an XML-like tag for use within an ADP.
 '''SYNOPSIS'''
-:       '''ns_register_proc'''
+: '''ns_adp_registerproc''' tag ''?endtag?'' proc
 '''DESCRIPTION'''
 '''SEE ALSO'''