'\"
'\" The contents of this file are subject to the AOLserver Public License
'\" Version 1.1 (the "License"); you may not use this file except in
'\" compliance with the License. You may obtain a copy of the License at
'\" http://aolserver.com/.
'\"
'\" Software distributed under the License is distributed on an "AS IS"
'\" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
'\" the License for the specific language governing rights and limitations
'\" under the License.
'\"
'\" The Original Code is AOLserver Code and related documentation
'\" distributed by AOL.
'\" 
'\" The Initial Developer of the Original Code is America Online,
'\" Inc. Portions created by AOL are Copyright (C) 1999 America Online,
'\" Inc. All Rights Reserved.
'\"
'\" Alternatively, the contents of this file may be used under the terms
'\" of the GNU General Public License (the "GPL"), in which case the
'\" provisions of GPL are applicable instead of those above.  If you wish
'\" to allow use of your version of this file only under the terms of the
'\" GPL and not to allow others to use your version of this file under the
'\" License, indicate your decision by deleting the provisions above and
'\" replace them with the notice and other provisions required by the GPL.
'\" If you do not delete the provisions above, a recipient may use your
'\" version of this file under either the License or the GPL.
'\" 
'\"
'\" $Header: /cvsroot/aolserver/aolserver/doc/Ns_UrlSpecific.3,v 1.4 2003/04/10 22:01:07 shmooved Exp $
'\"
'\" 
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",
'\"	or "in/out" to describe whether procedure reads or modifies arg,
'\"	and indent is equivalent to second arg of .IP (shouldn't ever be
'\"	needed;  use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\"	Give maximum sizes of arguments for setting tab stops.  Type and
'\"	name are examples of largest possible arguments that will be passed
'\"	to .AP later.  If args are omitted, default tab stops are used.
'\"
'\" .BS
'\"	Start box enclosure.  From here until next .BE, everything will be
'\"	enclosed in one large box.
'\"
'\" .BE
'\"	End of box enclosure.
'\"
'\" .CS
'\"	Begin code excerpt.
'\"
'\" .CE
'\"	End code excerpt.
'\"
'\" .VS ?version? ?br?
'\"	Begin vertical sidebar, for use in marking newly-changed parts
'\"	of man pages.  The first argument is ignored and used for recording
'\"	the version when the .VS was added, so that the sidebars can be
'\"	found and removed when they reach a certain age.  If another argument
'\"	is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\"	End of vertical sidebar.
'\"
'\" .DS
'\"	Begin an indented unfilled display.
'\"
'\" .DE
'\"	End of indented unfilled display.
'\"
'\" .SO
'\"	Start of list of standard options for a Tk widget.  The
'\"	options follow on successive lines, in four columns separated
'\"	by tabs.
'\"
'\" .SE
'\"	End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\"	Start of description of a specific option.  cmdName gives the
'\"	option's name as specified in the class command, dbName gives
'\"	the option's name in the option database, and dbClass gives
'\"	the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\"	Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.1 2006/06/26 00:29:11 jgdavidson Exp $
'\"
'\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1	\\fI\\$2\\fP	(\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\"	# BS - start boxed text
'\"	# ^y = starting y location
'\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"	# VS - start vertical sidebar
'\"	# ^Y = starting y location
'\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"	# Special macro to handle page bottom:  finish off current
'\"	# box/sidebar if in box/sidebar mode, then invoked standard
'\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
'\"	# DE - end display
.de DE
.fi
.RE
.sp
..
'\"	# SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
'\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
'\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..

.TH Ns_UrlSpecific 3aolserver 4.0 AOLserver "AOLserver Library Procedures"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
Ns_UrlSpecificAlloc, Ns_UrlSpecificDestroy, Ns_UrlSpecificGet, Ns_UrlSpecificGetExact, Ns_UrlSpecificGetFast, Ns_UrlSpecificSet \- Store and retrieve URL-specific data
.SH SYNOPSIS
.nf
\fB#include "ns.h"\fR
.sp
int
\fBNs_UrlSpecificAlloc\fR(\fIvoid\fR)
.sp
void *
\fBNs_UrlSpecificDestroy\fR(\fIchar *server, char *method, char *url,
    int id, int flags\fR)
.sp
void *
\fBNs_UrlSpecificGet\fR(\fIchar *server, char *method, char *url, 
    int id\fR)
.sp
void *
\fBNs_UrlSpecificGetExact\fR(\fIchar *server, char *method, char *url, 
    int id, int flags\fR)
.sp
void *
\fBNs_UrlSpecificGetFast\fR(\fIchar *server, char *method, char *url, 
    int id\fR)
.sp
void
\fBNs_UrlSpecificSet\fR(\fIchar *server, char *method, char *url, 
    int id, void *data, int flags, void (*deletefunc) (void *)\fR)
.BE

.SH DESCRIPTION
.PP
These functions allow you to store URL-specific data in memory for later
retrieval. They are used when registering procedures for example.
.TP
\fBNs_UrlSpecificAlloc\fR(\fI\fR)

Return a unique ID used to identify a unique virtual URL-space that is then
used with the Ns_UrlSpecific storage functions. You should only call this
function at server startup, and not after. Here is an example:

.CS
static int myId;

void
Init(void)
{
    /* Allocate the id once at startup. */
    myId = Ns_UrlSpecificAlloc();
}

void
Store(char *server, char *method, char *url, char *data)
{
    Ns_UrlSpecificSet(server, method, url, myId,
    data, 0, NULL);
}

char *
Fetch(char *server, char *method, char *url)
{
    char *data;

    data = Ns_UrlSpecificGet(server, method, url, myId);
    return (char *) data;
}
.CE
.TP
\fBNs_UrlSpecificDestroy\fR(\fIserver, method, url, id, flags\fR)

The Ns_UrlSpecificDestroy function deletes URL-specific data previously stored
with Ns_UrlSpecificSet with the same method/URL combination and the same
inheritance setting.

An id of -1 matches all ids. For example, Ns_UrlSpecificDestroy("myserver",
"GET", "/", -1, NS_OP_RECURSE) removes all data for the method GET for server
"myserver".

The flags argument can be:
.IP "" 7 
NS_OP_NODELETE - If set, the deletefunc specified in Ns_UrlSpeciciSet is run.
.IP
NS_OP_RECURSE - If set, then data for all URLs more specific than the passed-in
URL are also destroyed. 
.IP
NS_OP_NOINHERIT - If set, data that was stored with this flag in
Ns_UrlSpecificSet will be deleted.  If not set, the data stored without this
flag will be deleted.
.TP
\fBNs_UrlSpecificGet\fR(\fIserver, method, url, id\fR)

The Ns_UrlSpecificGet function retrieves the best match that it can find for in
the URL subspace identified by id that the passed-in URL matches. For instance,
suppose you had previously registered a handle/method/url/id
combination of {myserver, GET, /, 1} and {myserver, GET, /inventory, 1}. The
following call would match the data registered at {myserver, GET, /inventory,
1}: 

.CS
Ns_UrlSpecificGet("myserver", "GET", "/inventory/RJ45", 1)
.CE
.TP
\fBNs_UrlSpecificGetExact\fR(\fIserver, method, url, id, flags\fR)

Retrieves stored data for the exact method/URL/id combination specified that
was stored with the same inheritance setting.

If the flags argument is set to NS_OP_NOINHERIT,  the data stored with
NS_OP_NOINHERIT will be retrieved.  If the flags argument is set to 0, the data
stored without NS_OP_NOINHERIT will be retrieved.
.TP
\fBNs_UrlSpecificGetFast\fR(\fIserver, method, url, id\fR)

Same as Ns_UrlSpecificGet but does not support wildcards, making it much
faster.
.TP
\fBNs_UrlSpecificSet\fR(\fIserver, method, url, id, data, flags, deletefunc\fR)

The Ns_UrlSpecificSet function stores data in memory, allowing subsequent retrieval
using handle, method, url, id, and inheritance flag.

The flags argument can be NS_OP_NOINHERIT or NS_OP_NODELETE. You can
store two sets of data based on the same handle, method, url, and id combination-- one
set with inheritance on and one set with inheritance off. If the NS_OP_NOINHERIT
flag is set, the data is stored based on the exact URL. If NS_OP_NOINHERIT is
omitted, the data is stored based on the specified URL and any URL below it. In this
case, Ns_UrlSpecificGetExact will match to the closest URL when retrieving the data.

The deletefunc argument is called with data as an argument when this
handle/url/method/id combination is re-registered or deleted, or when this server shuts
down. unless NS_OP_NODELETE is set.

Normally, calling Ns_UrlSpecificSet on a handle/url/method/id combination which
already has an operation registered for it causes the previous operation's delete
procedure to be called. You can override this behavior by adding the
NS_OP_NODELETE flag.

.SH "SEE ALSO"
nsd(1), info(n)

.SH KEYWORDS