include/fcgios.h

   1 /*
   2  * fcgios.h --
   3  *
   4  *      Description of file.
   5  *
   6  *
   7  *  Copyright (c) 1996 Open Market, Inc.
   8  *  All rights reserved.
   9  *
  10  *  This file contains proprietary and confidential information and
  11  *  remains the unpublished property of Open Market, Inc. Use,
  12  *  disclosure, or reproduction is prohibited except as permitted by
  13  *  express written license agreement with Open Market, Inc.
  14  *
  15  *  Bill Snapper
  16  *  snapper@openmarket.com
  17  */
  18 #ifndef _FCGIOS_H
  19 #define _FCGIOS_H
  20
  21 #include "fcgi_config.h"
  22
  23 #ifdef HAVE_SYS_TIME_H
  24 #include <sys/time.h>
  25 #endif
  26
  27 #if defined (c_plusplus) || defined (__cplusplus)
  28 extern "C" {
  29 #endif
  30
  31
  32 #ifdef _WIN32
  33 #define OS_Errno GetLastError()
  34 #define OS_SetErrno(err) SetLastError(err)
  35 #ifndef DLLAPI
  36 #define DLLAPI __declspec(dllimport)
  37 #endif
  38 #ifndef O_NONBLOCK
  39 #define O_NONBLOCK     0x0004  /* no delay */
  40 #endif
  41 #else /* !_WIN32 */
  42 #define DLLAPI
  43 #define OS_Errno errno
  44 #define OS_SetErrno(err) errno = (err)
  45 #endif /* !_WIN32 */
  46
  47 /* This is the initializer for a "struct timeval" used in a select() call
  48  * right after a new request is accept()ed to determine readablity.  Its
  49  * a drop-dead timer.  Its only used for AF_UNIX sockets (not TCP sockets).
  50  * Its a workaround for a kernel bug in Linux 2.0.x and SCO Unixware.
  51  * Making this as small as possible, yet remain reliable would be best.
  52  * 2 seconds is very conservative.  0,0 is not reliable.  The shorter the
  53  * timeout, the faster request processing will recover.  The longer the
  54  * timeout, the more likely this application being "busy" will cause other
  55  * requests to abort and cause more dead sockets that need this timeout. */
  56 #define READABLE_UNIX_FD_DROP_DEAD_TIMEVAL 2,0
  57
  58 #ifndef STDIN_FILENO
  59 #define STDIN_FILENO  0
  60 #endif
  61
  62 #ifndef STDOUT_FILENO
  63 #define STDOUT_FILENO 1
  64 #endif
  65
  66 #ifndef STDERR_FILENO
  67 #define STDERR_FILENO 2
  68 #endif
  69
  70 #ifndef MAXPATHLEN
  71 #define MAXPATHLEN 1024
  72 #endif
  73
  74 #ifndef X_OK
  75 #define X_OK       0x01
  76 #endif
  77
  78 #ifndef _CLIENTDATA
  79 #   if defined(__STDC__) || defined(__cplusplus)
  80     typedef void *ClientData;
  81 #   else
  82     typedef int *ClientData;
  83 #   endif /* __STDC__ */
  84 #define _CLIENTDATA
  85 #endif
  86
  87 typedef void (*OS_AsyncProc) (ClientData clientData, int len);
  88
  89 DLLAPI int OS_LibInit(int stdioFds[3]);
  90 DLLAPI void OS_LibShutdown(void);
  91 DLLAPI int OS_CreateLocalIpcFd(const char *bindPath, int backlog);
  92 DLLAPI int OS_FcgiConnect(char *bindPath);
  93 DLLAPI int OS_Read(int fd, char * buf, size_t len);
  94 DLLAPI int OS_Write(int fd, char * buf, size_t len);
  95 DLLAPI int OS_SpawnChild(char *execPath, int listenFd);
  96 DLLAPI int OS_AsyncReadStdin(void *buf, int len, OS_AsyncProc procPtr,
  97                       ClientData clientData);
  98 DLLAPI int OS_AsyncRead(int fd, int offset, void *buf, int len,
  99                  OS_AsyncProc procPtr, ClientData clientData);
 100 DLLAPI int OS_AsyncWrite(int fd, int offset, void *buf, int len,
 101                   OS_AsyncProc procPtr, ClientData clientData);
 102 DLLAPI int OS_Close(int fd);
 103 DLLAPI int OS_CloseRead(int fd);
 104 DLLAPI int OS_DoIo(struct timeval *tmo);
 105 DLLAPI int OS_Accept(int listen_sock, int fail_on_intr, const char *webServerAddrs);
 106 DLLAPI int OS_IpcClose(int ipcFd);
 107 DLLAPI int OS_IsFcgi(int sock);
 108 DLLAPI void OS_SetFlags(int fd, int flags);
 109
 110 #if defined (__cplusplus) || defined (c_plusplus)
 111 } /* terminate extern "C" { */
 112 #endif
 113
 114 #endif /* _FCGIOS_H */