ns_adprequest(3aolserv) [debian man page]

Ns_Adp(3aolserver)					   AOLserver Library Procedures 					Ns_Adp(3aolserver)

__________________________________________________________________________________________________________________________________________________

NAME

       Ns_AdpRegisterParser, Ns_AdpRequest - Create and use ADP parsers

SYNOPSIS

       #include "ns.h"

       int
       Ns_AdpRegisterParser(char *extension, Ns_AdpParserProc *newParserProc)

       int
       Ns_AdpRequest(arg, arg)
_________________________________________________________________

DESCRIPTION

       These functions register new ADP parsers and run ADP requests.

       Ns_AdpRegisterParser(extension, newParserProc)

	      Registers  a  new,  named  ADP parser procedure with the name given in extension. You can tie a file extension to a particular named
	      parser in the nsd.tcl file. The newParserProc will be called when an ADP with the associated file extension needs to be parsed. If a
	      file  extension  is registered as an ADP in the nsd.tcl but no parser is associated with that file extension, the default ADP parser
	      is used.

	      The newParserProc must accept two arguments:

	      typedef void (Ns_AdpParserProc)(Ns_DString *out, char *in);

	      The ADP input is pointed to by in. Your parser must process the content of in and append the parsed output to out.

	      The output should be formatted as a series of concatenated "chunks". A chunk is a string of the format:

	      <type character><string><null>

	      where <type character> = 't' or 's'. A 't' means what follows is HTML and should be returned directly to the browser. An	's'  means
	      what follows is Tcl and should be evaluated.

	      After the last chunk there should be an extra <null> character. For example, the "adp" parser will take a page like this:

	      This is a test page<%ns_puts hi%>The end<%ns_puts bye%>

	      And create this output:

	      "tThis is a test pagesns_puts hitThe endsns_puts bye"

       Ns_AdpRequest(conn, file)

	      Parse and evaluate an ADP file.

SEE ALSO

       nsd(1), info(n)

KEYWORDS

AOLserver								4.0							Ns_Adp(3aolserver)

ns_adp_puts(3aolserver) 				    AOLserver Built-In Commands 				   ns_adp_puts(3aolserver)

__________________________________________________________________________________________________________________________________________________

NAME

       ns_adp_append,  ns_adp_close,  ns_adp_dump,  ns_adp_flush, ns_adp_puts, ns_adp_stream, ns_adp_tell, ns_adp_trunc, ns_puts - ADP output com-
       mands

SYNOPSIS

       ns_adp_append string ?string ...?
       ns_adp_close
       ns_adp_dump
       ns_adp_flush
       ns_adp_puts ?-nonewline? string
       ns_adp_stream
       ns_adp_tell
       ns_adp_trunc ?length?
       ns_puts ?-nonewline? string
_________________________________________________________________

DESCRIPTION

       These commands enable adding to and manipulation of the ADP output buffer.  See ns_adp for an overview on ADP pages.

       ns_adp_append string ?string ...?
	      This command appends one or more strings to the ADP output buffer.  For  the  case  of  a  single  argument,  it	is  equivalent	to
	      ns_adp_puts -nonewline string.

       ns_adp_close
	      This command can be used to flush and close the underlying HTTP connection.  ADP execution continues after the connection is closed;
	      any text appended to the output buffer after the close is simply discarded when processing is complete.

       ns_adp_dump
	      This command returns the text of the ADP buffer.

       ns_adp_flush
	      This command flushes the contents of the ADP buffer to the current connection or file channel. It will raise a Tcl exception if  the
	      underlying  flush failed, for example, if the HTTP connection is closed or the channel write failed.  Flushed content is returned in
	      "chunked-encoding" format if the HTTP protocol version is at least 1.1 (normally the case for  all  modern  browsers).   A  call	to
	      ns_adp_flush is not normally needed except for specialized applications as all content is automatically flushed at the end of a con-
	      nection or on buffer overflow.  (see ns_adp_ctl bufsize for details on buffer mangement).

       ns_adp_puts ?-nonewline? string
	      This function appends the specified string to the ADP buffer.  Unless the optional -nonewline argument is used, a  newline  will	be
	      appended	to the page after the string.  Note that the argument to ns_adp_puts is a single string unlike ns_adp_append which takes a
	      variable number of strings to append.

       ns_adp_stream
	      This function begins streaming mode for the ADP. All data currently in the ADP output buffer is flushed and any subsequent data will
	      be output directly to the connection.  It is equivalent to an ns_adp_flush followed by an ns_adp_ctl bufsize 0.

       ns_adp_tell
	      This  function  returns  the total number of bytes current in the ADP buffer.  A buffer overflow or direct call to ns_adp_flush will
	      reset this counter to zero so the result of ns_adp_tell may not return the total number of bytes eventually sent.

       ns_adp_trunc ?length?
	      This function can be used to truncate output buffer to the requested size. This can be useful to trim unintended white space  or	to
	      clear a result and generate an error message.  Note that content already streamed to the client, if any, cannot be truncated.

       ns_puts ?-nonewline? string
	      This command is a deprecated name for ns_adp_puts.

SEE ALSO

       ns_adp(n), ns_adp_include(n)

KEYWORDS

       ADP, dynamic pages

AOLserver								4.5						   ns_adp_puts(3aolserver)