'\"
'\" 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_ConnRead.3,v 1.7 2006/04/19 17:37:30 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_ConnRead 3aolserver 4.0 AOLserver "AOLserver Library Procedures"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
Ns_ConnGets, Ns_ConnRead, Ns_ConnFlushHeaders, Ns_ConnReadHeaders, Ns_ConnReadLine \- Routines to copy connection content
.SH SYNOPSIS
.nf
\fB#include "ns.h"\fR
.sp
char *
\fBNs_ConnGets\fR(\fIbuf, bufsize, conn\fR)
.sp
int
\fBNs_ConnFlushContent\fR(\fIconn\fR)
.sp
int
\fBNs_ConnRead\fR(\fIconn, vbuf, toread\fR)
.sp
int
\fBNs_ConnReadHeaders\fR(\fIconn, set, nreadPtr\fR)
.sp
int
\fBNs_ConnReadLine\fR(\fIconn, dsPtr, nreadPtr\fR)
.SH ARGUMENTS
.AS Ns_DString dsPtr in/out
.AP char *buf in
Pointer to string buffer of length \fIbufsize\fR.
.AP int bufsize in
Length of buffer pointer to by \fIbuf\fR.
.AP Ns_Conn conn in
Pointer to open connection.
.AP Ns_DString dsPtr out
Pointer to initialized dstring to receive copied line.
.AP int *nreadPtr out
Pointer to integer to receive number of bytes copied.
.AP Ns_Set set in/out
Pointer to initialized Ns_Set to copy headers.
.AP int toread in
Number of bytes to copy to location starting at \fIvbuf\fR
.AP void *vbuf in
Pointer to memory location to copy content.
.BE

.SH DESCRIPTION
.PP
These routines support copying content from the connection.  They
all operate by copying from the content buffer returned by a call
to \fBNs_ConnContent\fR, maintaining a private, shared offset into
the content.  This means that these routines are not actually reading
directly from the network and thus will not block waiting for input.
See the man page on \fBNs_ConnContent\fR for details on how the
content is pre-read by the server and how resources are managed for
small and large content requests.

.TP
char *\fBNs_ConnGets\fR(\fIbuf, bufsize, conn\fR)
Copies the next available line of text from the content to the given
\fIbuf\fR string, up to the given \fIbufsize\fR less space for a
trailing null (\\0).  The result is a pointer to \fIbuf\fR or NULL
if an underlying call to \fBNs_ConnRead\fR fails.

.TP
int \fBNs_ConnFlushContent\fR(\fIconn\fR)
Performs a logical flush of the underlying content available to
these routines.  It simply moves the private offset to the end of
the content.  The result is NS_OK unless an underlying call to
\fBNs_ConnContent\fR failed in which case NS_ERROR is returned.

.TP
int \fBNs_ConnRead\fR(\fIconn, vbuf, toread\fR)
Copies up to \fItoread\fR bytes from the content to the memory
location pointed to by \fIvbuf\fR.  The result is the number of
bytes copied which will match \fItoread\fR unless less bytes are
available in the input or -1 if an underlying call to \fBNs_ConnContent\fR
failed.

.TP
int \fBNs_ConnReadHeaders\fR(\fIconn, set, nreadPtr\fR)
Copies lines up to the first blank line or end of content up to the
maximum header read size specified with the communication driver
"maxheader" parameter (default: 32k).  Each line is parsed into
"key: value" pairs into the given Ns_Set pointed to be the \fIset\fR
argument using the \fBNs_ParseHeader\fR routine with the
\fINs_HeaderCaseDisposition\fR specified by the "headercase" server
option (default: Preserve).  The result is NS_OK if all lines were
consumed or NS_ERROR on overflow beyond the max header limit or if
there was an error with the underlying call to \fBNs_ConnRead\fR
(including an error of a single line beyond the max line limit as
described below).  The integer pointed to by the \fInreadPtr\fR
argument, if given, is updated with the total number of bytes
consumed.  This routine can be useful when parsing multipart/form-data
content to collect headers for each part.

.TP
int \fBNs_ConnReadLine\fR(\fIconn, dsPtr, nreadPtr\fR)
Copies the next available line to the given \fIdsPtr\fR dstring.
The integer pointed to by \fInreadPtr\fR, if present, is updated
with the number of bytes copied.  The line will not include the
trailing \\r\\n or \\n if present.  The function will return NS_OK
unless an underlying call to \fBNs_ConnContent\fR failed or the
line exceeds the maximum line read size specified by the communication
driver "maxline" parameter (default: 4k).  This routine differs
from \fBNs_ConnGets\fR in that it copies the result to a dstring
instead of a character buffer, requires a full \n or end-of-content
terminated line, and enforces the maxline limit.

.SH "SEE ALSO"
Ns_ConnContent(3), Ns_ParseHeader(3)

.SH KEYWORDS
connection, read, content