ns_connsetstatus(3aolserv) [debian man page]

Ns_ConnStatus(3aolserver)				   AOLserver Library Procedures 				 Ns_ConnStatus(3aolserver)

__________________________________________________________________________________________________________________________________________________

NAME

       Ns_ConnGetStatus, Ns_ConnSetStatus - Routines to manage the HTTP response status

SYNOPSIS

       #include "ns.h"

       int
       Ns_ConnGetStatus(conn)

       void
       Ns_ConnSetStatus(conn, status)

ARGUMENTS

       Ns_Conn	 conn	(in)	  Pointer to open connection.

       int	 status (in)	  Integer HTTP status code.
_________________________________________________________________

DESCRIPTION

       These  routines	manage the HTTP response code sent to the client in a later call to Ns_ConnFlush or Ns_ConnFlushDirect.  Higher level rou-
       tines such as the Ns_ConnReturn functions normally call these routines automatically using standard HTTP status codes and the Ns_ConnQueue-
       Headers routine can be used to set the status code for lower level code which bypasses Ns_ConnFlush.

       int Ns_ConnGetStatus(conn)
	      Return the current HTTP status to be sent.

       int Ns_ConnSetStatus(conn, status)
	      Set the status code to be sent in the response, for example, 200 for a normal "OK" response.  A later call to Ns_ConnFlush will con-
	      struct the appropriate HTTP response including the given status with the cooresponding string status code.

EXAMPLES

       The following example demonstrates setting an odd status code followed by a call to Ns_ConnFlushDirect to send some data:

		Ns_ConnSetStatus(conn, 600);
		Ns_ConnSetType(conn, "text/plain");
		Ns_ConnFlushDirect(conn, "hello", 5, 0);

       The following should provide similar results:

		Ns_ConnSetRequiredHeaders(conn, "text/plain", 5);
		Ns_ConnQueueHeaders(conn, 600);
		Ns_ConnPuts(conn, "hello");
		Ns_ConnClose(conn);

SEE ALSO

       Ns_ConnGetType(3),  Ns_ConnSetType(3),  Ns_ConnFlush(3),   Ns_ConnFlushDirect(3),   Ns_ConnSetRequiredHeaders(3),   Ns_ConnQueueHeaders(3),
       ns_conn(n)

KEYWORDS

       connectionn, response, status

AOLserver								4.0						 Ns_ConnStatus(3aolserver)

Ns_ConnReturnData(3aolserver)				   AOLserver Library Procedures 			     Ns_ConnReturnData(3aolserver)

__________________________________________________________________________________________________________________________________________________

NAME

       Ns_ConnReturnAdminNotice, Ns_ConnReturnData, Ns_ConnReturnHtml, Ns_ConnReturnNotice - Routines to generate simple single-buffer responses

SYNOPSIS

       #include "ns.h"
       int
       Ns_ConnReturnAdminNotice(conn, status, title, msg)

       int
       Ns_ConnReturnData(conn, status, data, len, type)

       int
       Ns_ConnReturnCharData(conn, status, data, len, type)

       int
       Ns_ConnReturnHtml(conn, status, msg, len)

       int
       Ns_ConnReturnNotice(conn, status, title, msg)

ARGUMENTS

       Ns_Conn	 conn	(in)	  Pointer to open connection.

       int	 status (in)	  HTTP response status code.

       char	 *type	(in)	  Output content type.

       char	 *title (in)	  Pointer to HTML page title string.

       int	 len	(in)	  Length of content buffer.

       char	 *data	(in)	  Pointer to content buffer.

       char	 *msg	(in)	  Pointer to HTML message buffer.
_________________________________________________________________

DESCRIPTION

       These  routines	are used to generate complete responses, including headers, status codes, content types, and the requested data.  They all
       return a status code which is NS_OK if the response was sent or NS_ERROR if an underlying call to sent the content failed.

       int Ns_ConnReturnAdminNotice(conn, status, title, msg)
	      This routine is equivalent to Ns_ConnReturnNotice. In prior versions, it would format a slightly different response which was  later
	      considered inconsequential.

       int Ns_ConnReturnData(conn, status, data, len, type)
	      Generates  a reponse with the given HTTP status including a content-type header with the given type.  Content pointed to by the data
	      argument of length len is then sent without any modification via an underlying call to Ns_ConnFlushDirect.

       int Ns_ConnReturnCharData(conn, status, data, len, type)
	      Generates a response as with Ns_ConnReturnData except that the given content pointed to by data is assumed to be a text stream which
	      is output encoded using the appropriate Tcl_Encoding based on the given type mimetype and possibly gzip compressed via an underlying
	      call to Ns_ConnFlush.

       int Ns_ConnReturnHtml(conn, status, msg, len)
	      This is equivalent to Ns_ConnReturnCharData(conn, status, msg, len, "text/html").

       int Ns_ConnReturnNotice(conn, status, title, msg)
	      Constructs a basic HTML response and sends it via Ns_ConnReturnHtml.  The title string is placed both in the <head> portion as  well
	      as  an  <h2>  tag in the <body> portion of the document.	If the title is NULL, it defaults to the string "Server Message".  The msg
	      string, if not NULL, follows the body and is copied unaltered.  This routine is useful for generating  very  basic  responses.   For
	      example, it is used by the various builtin reponse routines such as Ns_ConnReturnUnauthorized.

SEE ALSO

       Ns_ConnFlush(3), Ns_ConnReturnFile, Ns_ConnReturnOpenFd, Ns_ConnReturnUnathorized.

KEYWORDS

       connnection, encoding, response

AOLserver								4.0					     Ns_ConnReturnData(3aolserver)