1NAME
2 FCGI_StartFilterData ‐ fcgi_stdio compatibility library
3
4SYNOPSIS
5 #include "fcgi_stdio.h"
6
7 int
8 FCGI_StartFilterData(void);
9
10
11DESCRIPTION
12 Enables a FastCGI Filter application to begin reading its
13filter
14 input data from stdin.
15
16 In order to call FCGI_StartFilterData, the FastCGI
17 application should have been invoked in the Filter role
18 (getenv("FCGI_ROLE") == "FILTER"), and should have read
19 stdin to EOF, consuming the entire FCGI_STDIN data stream.
20 The call to FCGI_StartFilterData positions stdin at the
21 start of FCGI_DATA.
22
23 If the preconditions are not met (e.g. the application has
24 not read stdin to EOF), FCGI_StartFilterData returns
25 a negative result, and the application will get EOF on at‐
26tempts
27 to read from stdin.
28
29 The application can determine the number of bytes available
30 on FCGI_DATA by performing atoi(getenv("FCGI_DATA_LENGTH")).
31 If fewer than this many bytes are delievered on stdin after
32 calling FCGI_StartFilterData, the application should perform
33 an application‐specific error response. If the application
34 normally makes an update, most likely it should abort the
35update.
36
37 The application can determine last modification time of the
38 filter input data by performing getenv("FCGI_DA‐
39TA_LAST_MOD").
40 This allows applications to perform caching based on last
41 modification time.
42
43
44RETURN VALUES
45 0 for successful call, < 0 for error.
46
47SEE ALSO
48 FCGI_Accept(3)
49 FCGI_SetExitStatus(3)
50 cgi‐fcgi(1)
51
52HISTORY
53 Copyright (c) 1996 Open Market, Inc.
54 See the file "LICENSE.TERMS" for information on usage and
55redistribution
56 of this file, and for a DISCLAIMER OF ALL WARRANTIES.
57 $Id: FCGI_StartFilterData.3,v 1.1.1.1 1997/09/16 15:36:26
58stanleyg Exp $
59
60
61
62
63
64
65
66