'\"
'\" 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_ConnReturnStatus.3,v 1.3 2006/07/07 03:27:22 jgdavidson 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_ConnReturnStatus 3aolserver 4.0 AOLserver "AOLserver Library Procedures"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
Ns_ConnReturnBadRequest, Ns_ConnReturnForbidden, Ns_ConnReturnInternalError, Ns_ConnReturnNoResponse, Ns_ConnReturnNotFound, Ns_ConnReturnNotImplemented, Ns_ConnReturnNotModified, Ns_ConnReturnOk, Ns_ConnReturnStatus, Ns_ConnReturnUnauthorized, Ns_RegisterRedirect \- Routines to return simple standard responses
.SH SYNOPSIS
.nf
\fB#include "ns.h"\fR
.sp
int
\fBNs_ConnReturnBadRequest\fR(\fIconn, msg\fR)
.sp
int
\fBNs_ConnReturnForbidden\fR(\fIconn\fR)
.sp
int
\fBNs_ConnReturnInternalError\fR(\fIconn\fR)
.sp
int
\fBNs_ConnReturnNoResponse\fR(\fIconn\fR)
.sp
int
\fBNs_ConnReturnNotFound\fR(\fIconn\fR)
.sp
int
\fBNs_ConnReturnNotImplemented\fR(\fIconn\fR)
.sp
int
\fBNs_ConnReturnNotModified\fR(\fIconn\fR)
.sp
int
\fBNs_ConnReturnOk\fR(\fIconn\fR)
.sp
int
\fBNs_ConnReturnStatus\fR(\fIconn, status\fR)
.sp
int
\fBNs_ConnReturnUnauthorized\fR(\fIconn\fR)
.sp
void
\fBNs_RegisterRedirect\fR(\fIserver, status, url\fR)
.SH ARGUMENTS
.AS Ns_Conn conn in
.AP Ns_Conn conn in
Pointer to open connection.
.AP char *msg in
String with additional message text.
.AP int status in
Integer HTTP status code.
.AP char *url in
String which specifies internal redirection url.
.AP char *server in
Virtual server.
.BE

.SH DESCRIPTION
.PP
These routines are used to generate complete responses, including
headers, approriate status codes, content types, and possibly short
HTML content messages for the most common HTTP error or status
responses.  They each coorespond to a particular HTTP status code,
for example, \fBNs_ConnReturnNotFound\fR generates an HTTP 404 "Not
Found" response.  They all return NS_OK if the response was sent
or NS_ERROR if an underlying routine failed.

.PP
The default behavior is to return an internal, server generated
response possibly with a short English language message, for example
"The requested URL cannot be accessed by this server".  This behavior
can be modified by calling the \fBNs_RegisterRedirect\fR to redirect
responses internally for the cooresponding HTTP status code to
another URL on the server.  The "redirects" server config section
can be used to map these redirects at startup

.TP
int \fBNs_ConnReturnBadRequest\fR(\fIconn, msg\fR)
Returns an HTTP 400 response with the short HTML message "Invalid
Request: The HTTP request presented by your browser is invalid."
The optional \fImsg\fR string, if present, is also included in the
message body.

.TP
int \fBNs_ConnReturnForbidden\fR(\fIconn\fR)
Returns an HTTP 403 response with the short HTML message "Forbidden:
The requested URL cannot be accessed by this server."

.TP
int \fBNs_ConnReturnInternalError\fR(\fIconn\fR)
Returns an HTTP 500 response with the short HTML message "Server
Error: The requested URL cannot be accessed due to a system error
on this server."

.TP
int \fBNs_ConnReturnNoResponse\fR(\fIconn\fR)
Equivalent to \fBNs_ConnReturnStatus\fR(\fIconn, 204\fR).

.TP
int \fBNs_ConnReturnNotFound\fR(\fIconn\fR)
Returns an HTTP 404 response with the short HTML message "Not Found:
The requested URL was not found on this server."

.TP
int \fBNs_ConnReturnNotImplemented\fR(\fIconn\fR)
Returns an HTTP 404 response with the short HTML message "Not
Implemented: The requested URL or method is not implemented by this
server."

.TP
int \fBNs_ConnReturnNotModified\fR(\fIconn\fR)
Equivalent to \fBNs_ConnReturnStatus\fR(\fIconn, 304\fR).

.TP
int \fBNs_ConnReturnOk\fR(\fIconn\fR)
Equivalent to \fBNs_ConnReturnStatus\fR(\fIconn, 200\fR).

.TP
int \fBNs_ConnReturnStatus\fR(\fIconn, status\fR)
Generates a response with the given HTTP \fIstatus\fR with no
content.

.TP
int \fBNs_ConnReturnUnauthorized\fR(\fIconn\fR)
Returns an HTTP 401 response with the short HTML message "Access
Denied: The requested URL cannot be accessed because a valid username
and password are required."  As "WWW-Authenticate: Basic realm=\fIserver
realm\fR" header is also included in the response.

.TP
void \fBNs_RegisterRedirect\fR(\fIserver, status, url\fR)
Redirect the above responses from the given \fIserver\fR for the
given \fIstatus\fR code from the simple internal messages described
above to the given internal \fRurl\fR. The redirect is performed
using \fBNs_ConnRedirect\fR.

.SH "SEE ALSO"
Ns_ConnFlush(3), Ns_ConnRedirect(3), Ns_ConnSetRequiredHeaders(3),
Ns_ConnQueueHeaders(3), ns_return(n)

.SH KEYWORDS
connnection, response