[catagits/fcgi2.git] / doc / FCGI_Finish.3

NAME
     FCGI_Finish
         - fcgi_stdio compatibility library

SYNOPSIS
     #include "fcgi_stdio.h"

     void
     FCGI_Finish(void);


DESCRIPTION
     The FCGI_Finish function finishes the current request from the
     HTTP server.  The current request was started by the most recent
     call to FCGI_Accept(3).

     FCGI_Finish allows an application to interleave other activities
     with the processing of requests.  In an extreme case, an
     application would call FCGI_Finish to complete the current
     request before exiting, e.g. to reclaim leaked storage.

     In completing the current request, FCGI_Finish may detect
     errors, e.g. a broken pipe to a client who has disconnected
     early.  FCGI_Finish ignores such errors.  An application
     that wishes to handle such errors should explicitly call
     fclose(stderr), then fclose(stdout); an EOF return from
     either one indicates an error.

     FCGI_Finish frees any storage allocated by the most recent call
     to FCGI_Accept.  See FCGI_Accept(3) for warnings against retaining
     pointers to this storage.


SEE ALSO
     FCGI_Accept(3)

HISTORY
     Copyright (c) 1996 Open Market, Inc.
     See the file "LICENSE" for information on usage and redistribution
     of this file, and for a DISCLAIMER OF ALL WARRANTIES.
     $Id: FCGI_Finish.3,v 1.1 1997/09/16 15:36:25 stanleyg Exp $
Commit	Line	Data
0198fd3c	1	NAME
	2	FCGI_Finish
	3	- fcgi_stdio compatibility library
	4
	5	SYNOPSIS
	6	#include "fcgi_stdio.h"
	7
	8	void
	9	FCGI_Finish(void);
	10
	11
	12	DESCRIPTION
	13	The FCGI_Finish function finishes the current request from the
	14	HTTP server. The current request was started by the most recent
	15	call to FCGI_Accept(3).
	16
	17	FCGI_Finish allows an application to interleave other activities
	18	with the processing of requests. In an extreme case, an
	19	application would call FCGI_Finish to complete the current
	20	request before exiting, e.g. to reclaim leaked storage.
	21
	22	In completing the current request, FCGI_Finish may detect
	23	errors, e.g. a broken pipe to a client who has disconnected
	24	early. FCGI_Finish ignores such errors. An application
	25	that wishes to handle such errors should explicitly call
	26	fclose(stderr), then fclose(stdout); an EOF return from
	27	either one indicates an error.
	28
	29	FCGI_Finish frees any storage allocated by the most recent call
	30	to FCGI_Accept. See FCGI_Accept(3) for warnings against retaining
	31	pointers to this storage.
	32
	33
	34	SEE ALSO
	35	FCGI_Accept(3)
	36
	37	HISTORY
	38	Copyright (c) 1996 Open Market, Inc.
af1b4cad	39	See the file "LICENSE" for information on usage and redistribution
0198fd3c	40	of this file, and for a DISCLAIMER OF ALL WARRANTIES.
0198fd3c	41	$Id: FCGI_Finish.3,v 1.1 1997/09/16 15:36:25 stanleyg Exp $