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 #ifdef _WIN32
  22 #define WIN32_LEAN_AND_MEAN
  23 #include <windows.h>
  24 #include <winsock2.h>
  25 #endif
  26
  27 #include "fcgi_config.h"
  28
  29 #ifdef HAVE_SYS_TIME_H
  30 #include <sys/time.h>
  31 #endif
  32
  33 #if defined (c_plusplus) || defined (__cplusplus)
  34 extern "C" {
  35 #endif
  36
  37 #ifdef _WIN32
  38 #define OS_Errno GetLastError()
  39 #define OS_SetErrno(err) SetLastError(err)
  40 #ifndef O_NONBLOCK
  41 #define O_NONBLOCK     0x0004  /* no delay */
  42 #endif
  43 #else /* !_WIN32 */
  44 #define OS_Errno errno
  45 #define OS_SetErrno(err) errno = (err)
  46 #endif /* !_WIN32 */
  47
  48 #ifndef DLLAPI
  49 #ifdef _WIN32
  50 #define DLLAPI __declspec(dllimport)
  51 #else
  52 #define DLLAPI
  53 #endif
  54 #endif
  55
  56
  57 /* This is the initializer for a "struct timeval" used in a select() call
  58  * right after a new request is accept()ed to determine readablity.  Its
  59  * a drop-dead timer.  Its only used for AF_UNIX sockets (not TCP sockets).
  60  * Its a workaround for a kernel bug in Linux 2.0.x and SCO Unixware.
  61  * Making this as small as possible, yet remain reliable would be best.
  62  * 2 seconds is very conservative.  0,0 is not reliable.  The shorter the
  63  * timeout, the faster request processing will recover.  The longer the
  64  * timeout, the more likely this application being "busy" will cause other
  65  * requests to abort and cause more dead sockets that need this timeout. */
  66 #define READABLE_UNIX_FD_DROP_DEAD_TIMEVAL 2,0
  67
  68 #ifndef STDIN_FILENO
  69 #define STDIN_FILENO  0
  70 #endif
  71
  72 #ifndef STDOUT_FILENO
  73 #define STDOUT_FILENO 1
  74 #endif
  75
  76 #ifndef STDERR_FILENO
  77 #define STDERR_FILENO 2
  78 #endif
  79
  80 #ifndef MAXPATHLEN
  81 #define MAXPATHLEN 1024
  82 #endif
  83
  84 #ifndef X_OK
  85 #define X_OK       0x01
  86 #endif
  87
  88 #ifndef _CLIENTDATA
  89 #   if defined(__STDC__) || defined(__cplusplus)
  90     typedef void *ClientData;
  91 #   else
  92     typedef int *ClientData;
  93 #   endif /* __STDC__ */
  94 #define _CLIENTDATA
  95 #endif
  96
  97 typedef void (*OS_AsyncProc) (ClientData clientData, int len);
  98
  99 DLLAPI int OS_LibInit(int stdioFds[3]);
 100 DLLAPI void OS_LibShutdown(void);
 101 DLLAPI int OS_CreateLocalIpcFd(const char *bindPath, int backlog);
 102 DLLAPI int OS_FcgiConnect(char *bindPath);
 103 DLLAPI int OS_Read(int fd, char * buf, size_t len);
 104 DLLAPI int OS_Write(int fd, char * buf, size_t len);
 105 DLLAPI int OS_SpawnChild(char *execPath, int listenFd);
 106 DLLAPI int OS_AsyncReadStdin(void *buf, int len, OS_AsyncProc procPtr,
 107                       ClientData clientData);
 108 DLLAPI int OS_AsyncRead(int fd, int offset, void *buf, int len,
 109                  OS_AsyncProc procPtr, ClientData clientData);
 110 DLLAPI int OS_AsyncWrite(int fd, int offset, void *buf, int len,
 111                   OS_AsyncProc procPtr, ClientData clientData);
 112 DLLAPI int OS_Close(int fd);
 113 DLLAPI int OS_CloseRead(int fd);
 114 DLLAPI int OS_DoIo(struct timeval *tmo);
 115 DLLAPI int OS_Accept(int listen_sock, int fail_on_intr, const char *webServerAddrs);
 116 DLLAPI int OS_IpcClose(int ipcFd);
 117 DLLAPI int OS_IsFcgi(int sock);
 118 DLLAPI void OS_SetFlags(int fd, int flags);
 119
 120 #if defined (__cplusplus) || defined (c_plusplus)
 121 } /* terminate extern "C" { */
 122 #endif
 123
 124 #endif /* _FCGIOS_H */