Ignore fcgi_config.h
[catagits/fcgi2.git] / include / fcgiapp.h
index f0f331b..9abd2c6 100644 (file)
@@ -9,7 +9,7 @@
  * See the file "LICENSE.TERMS" for information on usage and redistribution
  * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  *
- * $Id: fcgiapp.h,v 1.3 1999/07/28 00:27:51 roberts Exp $
+ * $Id: fcgiapp.h,v 1.8 2001/06/22 14:19:23 robs Exp $
  */
 
 #ifndef _FCGIAPP_H
 extern "C" {
 #endif
 
-#ifdef _WIN32
-
 #ifndef DLLAPI
+#ifdef _WIN32
 #define DLLAPI __declspec(dllimport)
-#endif
-
-#else  /* !_WIN32 */
-
+#else
 #define DLLAPI
-
-#endif /* !_WIN32 */
+#endif
+#endif
 
 /*
  * Error codes.  Assigned to avoid conflict with EOF and errno(2).
@@ -80,22 +76,36 @@ typedef struct FCGX_Stream {
 typedef char **FCGX_ParamArray;
 
 /*
- * State associated with a request.
+ * FCGX_Request Flags
+ *
+ * Setting FCGI_FAIL_ACCEPT_ON_INTR prevents FCGX_Accept() from
+ * restarting upon being interrupted.
+ */
+#define FCGI_FAIL_ACCEPT_ON_INTR       1
+
+/*
+ * FCGX_Request -- State associated with a request.
  *
- * Its exposed for API simplicity, DON'T use it - it WILL change!
+ * Its exposed for API simplicity, I expect parts of it to change!
  */
 typedef struct FCGX_Request {
+    int requestId;            /* valid if isBeginProcessed */
+    int role;
+    FCGX_Stream *in;
+    FCGX_Stream *out;
+    FCGX_Stream *err;
+       char **envp;
+
+       /* Don't use anything below here */
+
+    struct Params *paramsPtr;
     int ipcFd;               /* < 0 means no connection */
     int isBeginProcessed;     /* FCGI_BEGIN_REQUEST seen */
-    int requestId;            /* valid if isBeginProcessed */
     int keepConnection;       /* don't close ipcFd at end of request */
-    int role;
     int appStatus;
     int nWriters;             /* number of open writers (0..2) */
-    FCGX_Stream *inStream;
-    FCGX_Stream *outStream;
-    FCGX_Stream *errStream;
-    struct Params *paramsPtr;
+       int flags;
+       int listen_sock;
 } FCGX_Request;
 
 \f
@@ -134,13 +144,35 @@ DLLAPI int FCGX_Init(void);
 /*
  *----------------------------------------------------------------------
  *
+ * FCGX_OpenSocket --
+ *
+ *     Create a FastCGI listen socket.
+ *
+ *     path is the Unix domain socket (named pipe for WinNT), or a colon
+ *     followed by a port number.  e.g. "/tmp/fastcgi/mysocket", ":5000"
+ *
+ *     backlog is the listen queue depth used in the listen() call.
+ *
+ *  Returns the socket's file descriptor or -1 on error.
+ *
+ *----------------------------------------------------------------------
+ */
+DLLAPI int FCGX_OpenSocket(const char *path, int backlog);
+
+/*
+ *----------------------------------------------------------------------
+ *
  * FCGX_InitRequest --
  *
- *      Initialize a FCGX_Request for use with FCGX_Accept_r().
+ *     Initialize a FCGX_Request for use with FCGX_Accept_r().
  *
+ *     sock is a file descriptor returned by FCGX_OpenSocket() or 0 (default).
+ *     The only supported flag at this time is FCGI_FAIL_ON_INTR.
+ *
+ *     Returns 0 upon success.
  *----------------------------------------------------------------------
  */
-DLLAPI void FCGX_InitRequest(FCGX_Request *request);
+DLLAPI int FCGX_InitRequest(FCGX_Request *request, int sock, int flags);
 
 /*
  *----------------------------------------------------------------------
@@ -172,12 +204,7 @@ DLLAPI void FCGX_InitRequest(FCGX_Request *request);
  *
  *----------------------------------------------------------------------
  */
-DLLAPI int FCGX_Accept_r(
-        FCGX_Stream **in,
-        FCGX_Stream **out,
-        FCGX_Stream **err,
-        FCGX_ParamArray *envp,
-        FCGX_Request *request);
+DLLAPI int FCGX_Accept_r(FCGX_Request *request);
 
 /*
  *----------------------------------------------------------------------
@@ -203,6 +230,18 @@ DLLAPI void FCGX_Finish_r(FCGX_Request *request);
 /*
  *----------------------------------------------------------------------
  *
+ * FCGX_Free --
+ *
+ *      Free the memory and, if close is true, 
+ *         IPC FD associated with the request (multi-thread safe).
+ *
+ *----------------------------------------------------------------------
+ */
+DLLAPI void FCGX_Free(FCGX_Request * request, int close);
+
+/*
+ *----------------------------------------------------------------------
+ *
  * FCGX_Accept --
  *
  *      Accept a new request (NOT multi-thread safe).
@@ -540,6 +579,34 @@ DLLAPI int FCGX_GetError(FCGX_Stream *stream);
  */
 DLLAPI void FCGX_ClearError(FCGX_Stream *stream);
 
+/*
+ *----------------------------------------------------------------------
+ *
+ * FCGX_CreateWriter --
+ *
+ *      Create a FCGX_Stream (used by cgi-fcgi).  This shouldn't 
+ *      be needed by a FastCGI applictaion.
+ *
+ *----------------------------------------------------------------------
+ */
+DLLAPI FCGX_Stream *FCGX_CreateWriter(
+        int socket,
+        int requestId,
+        int bufflen,
+        int streamType);
+
+/*
+ *----------------------------------------------------------------------
+ *
+ * FCGX_FreeStream --
+ *
+ *      Free a FCGX_Stream (used by cgi-fcgi).  This shouldn't 
+ *      be needed by a FastCGI applictaion.
+ *
+ *----------------------------------------------------------------------
+ */
+DLLAPI void FCGX_FreeStream(FCGX_Stream **stream);
+
 
 #if defined (__cplusplus) || defined (c_plusplus)
 } /* terminate extern "C" { */