home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 1998 May / Pcwk5b98.iso / WEBSERVE / PI3 / PI3WEB.EXE / DEVEL / INCLUDE / HTTPCore.h next >
Encoding:
C/C++ Source or Header  |  1997-10-19  |  9.3 KB  |  363 lines
  1. /*____________________________________________________________________________*\
  2.  *
  3.  
  4.  Copyright (c) 1997 John Roy. All rights reserved.
  5.  
  6.  These sources, libraries and applications are
  7.  FREE FOR COMMERCIAL AND NON-COMMERCIAL USE
  8.  as long as the following conditions are adhered to.
  9.  
  10.  Redistribution and use in source and binary forms, with or without
  11.  modification, are permitted provided that the following conditions
  12.  are met:
  13.  
  14.  1. Redistributions of source code must retain the above copyright
  15.     notice, this list of conditions and the following disclaimer. 
  16.  
  17.  2. Redistributions in binary form must reproduce the above copyright
  18.     notice, this list of conditions and the following disclaimer in
  19.     the documentation and/or other materials provided with the
  20.     distribution.
  21.  
  22.  3. Redistributions of any form whatsoever and all advertising materials 
  23.     mentioning features must contain the following
  24.     acknowledgment:
  25.     "This product includes software developed by John Roy
  26.     (http://www.johnroy.com/pi3/)."
  27.  
  28.  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  29.  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30.  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  31.  IN NO EVENT SHALL THE AUTHORS OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  32.  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33.  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34.  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35.  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  36.  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  37.  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  38.  OF THE POSSIBILITY OF SUCH DAMAGE.
  39.  
  40.  *____________________________________________________________________________*|
  41.  *
  42.  * $Source: HTTPCore.h$
  43.  * $Date: Sun Aug 10 06:36:30 1997$
  44.  *
  45.  Description:
  46. \*____________________________________________________________________________*/
  47. /* $SourceTop:$ */
  48.  
  49. #ifndef HTTPCORE_H_
  50. #define HTTPCORE_H_
  51.  
  52. #include "Pi3API.h"
  53.  
  54. /*____________________________________________________________________________*\
  55.  Description: Flags
  56. \*____________________________________________________________________________*/
  57. #define RH_CLIENTREQUEST    (1)
  58. #define RH_RESPONSE            (2)
  59.  
  60. /* --- debug levels for HTTPCore_logDebug() --- */
  61. #define DBG_LOW                (100)
  62. #define DBG_MED                (50)
  63. #define DBG_HIGH            (1)
  64.  
  65. /*____________________________________________________________________________*\
  66.  *
  67.  Name:
  68.     HTTPCore_init
  69.  
  70.  Synopsis:
  71.     int HTTPCore_init( PIObject *pObject )
  72.  
  73.  Description:
  74.     This function is not yet documented.
  75.  
  76.  Notes:
  77.  Return Values:
  78.  Errors:
  79.  See Also:
  80. \*____________________________________________________________________________*/
  81. PUBLIC_PIAPI int HTTPCore_init( PIObject *pObject );
  82.  
  83. /*____________________________________________________________________________*\
  84.  *
  85.  Name:
  86.     HTTPCore_cleanup
  87.  
  88.  Synopsis:
  89.     int HTTPCore_cleanup()
  90.  
  91.  Description:
  92.     This function is not yet documented.
  93.  
  94.  Notes:
  95.  Return Values:
  96.  Errors:
  97.  See Also:
  98. \*____________________________________________________________________________*/
  99. PUBLIC_PIAPI int HTTPCore_cleanup();
  100.  
  101. /*____________________________________________________________________________*\
  102.  *
  103.  Name:
  104.     HTTPCore_readHeaders
  105.  
  106.  Synopsis:
  107.     int HTTPCore_readHeaders( PIIOBuffer *pB, PIDB *pDB, int iFlags )
  108.  
  109.  Description:
  110.     This function is not yet documented.
  111.  
  112.  Notes:
  113.  Return Values:
  114.  Errors:
  115.  See Also:
  116. \*____________________________________________________________________________*/
  117. PUBLIC_PIAPI int HTTPCore_readHeaders( PIIOBuffer *pB, PIDB *pDB, int iFlags );
  118.  
  119. /*____________________________________________________________________________*\
  120.  *
  121.  Name:
  122.     HTTPCore_sendGeneralHeaders
  123.  
  124.  Synopsis:
  125.     int HTTPCore_sendGeneralHeaders( PIHTTP *pPIHTTP )    
  126.  
  127.  Description:
  128.     This function is not yet documented.
  129.  
  130.  Notes:
  131.  Return Values:
  132.  Errors:
  133.  See Also:
  134. \*____________________________________________________________________________*/
  135. PUBLIC_PIAPI int HTTPCore_sendGeneralHeaders( PIHTTP *pPIHTTP );    
  136.  
  137. /*____________________________________________________________________________*\
  138.  *
  139.  Name:
  140.     HTTPCore_sendEntityHeaders
  141.  
  142.  Synopsis:
  143.     int HTTPCore_sendEntityHeaders( PIHTTP *pPIHTTP, PIDB *pR )
  144.  
  145.  Description:
  146.     This function is not yet documented.
  147.  
  148.  Notes:
  149.  Return Values:
  150.  Errors:
  151.  See Also:
  152. \*____________________________________________________________________________*/
  153. PUBLIC_PIAPI int HTTPCore_sendEntityHeaders( PIHTTP *pPIHTTP, PIDB *pR );
  154.  
  155. /*____________________________________________________________________________*\
  156.  *
  157.  Name:
  158.     HTTPCore_getCachedFile
  159.  
  160.  Synopsis:
  161.     PIFInfo *HTTPCore_getCachedFile( const char *pPath )
  162.  
  163.  Description:
  164.     This function is not yet documented.
  165.  
  166.  Notes:
  167.  Return Values:
  168.  Errors:
  169.  See Also:
  170. \*____________________________________________________________________________*/
  171. PUBLIC_PIAPI PIFInfo *HTTPCore_getCachedFile( const char *pPath );
  172.  
  173. /*____________________________________________________________________________*\
  174.  *
  175.  Name:
  176.     HTTPCore_getServerStamp
  177.  
  178.  Synopsis:
  179.     const char *HTTPCore_getServerStamp()
  180.  
  181.  Description:
  182.     This function is not yet documented.
  183.  
  184.  Notes:
  185.  Return Values:
  186.  Errors:
  187.  See Also:
  188. \*____________________________________________________________________________*/
  189. PUBLIC_PIAPI const char *HTTPCore_getServerStamp();
  190.  
  191. /*____________________________________________________________________________*\
  192.  *
  193.  Name:
  194.     HTTPCore_releaseCachedFile
  195.  
  196.  Synopsis:
  197.     void HTTPCore_releaseCachedFile( PIFInfo *pInfo )
  198.  
  199.  Description:
  200.     This function is not yet documented.
  201.  
  202.  Notes:
  203.  Return Values:
  204.  Errors:
  205.  See Also:
  206. \*____________________________________________________________________________*/
  207. PUBLIC_PIAPI void HTTPCore_releaseCachedFile( PIFInfo *pInfo );
  208.  
  209. /*____________________________________________________________________________*\
  210.  *
  211.  Name:
  212.     HTTPCore_loadMIMEFile
  213.  
  214.  Synopsis:
  215.     int HTTPCore_loadMIMEFile( PIObject *pObject, PIDB *pMimeDB,
  216.     const char *pMimeFile )
  217.  
  218.  Description:
  219.     This function is not yet documented.
  220.  
  221.  Notes:
  222.  Return Values:
  223.  Errors:
  224.  See Also:
  225. \*____________________________________________________________________________*/
  226. PUBLIC_PIAPI int HTTPCore_loadMIMEFile( PIObject *pObject, PIDB *pMimeDB,
  227.     const char *pMimeFile );
  228.  
  229. /*____________________________________________________________________________*\
  230.  *
  231.  Name:
  232.     HTTPCore_getMIMETypeFromExtension
  233.  
  234.  Synopsis:
  235.     const char *HTTPCore_getMIMETypeFromExtension( const char *pExtension )
  236.  
  237.  Description:
  238.     This function is not yet documented.
  239.  
  240.  Notes:
  241.  Return Values:
  242.  Errors:
  243.  See Also:
  244. \*____________________________________________________________________________*/
  245. PUBLIC_PIAPI const char *HTTPCore_getMIMETypeFromExtension(
  246.         const char *pExtension );
  247.  
  248. /*____________________________________________________________________________*\
  249.  *
  250.  Name:
  251.     HTTPCore_relativeToAbsolutePath
  252.  
  253.  Synopsis:
  254.     int HTTPCore_relativeToAbsolutePath( const char *pRelative,
  255.         Pi3String *pResult )
  256.  
  257.  Description:
  258.     This function is not yet documented.
  259.  
  260.  Notes:
  261.  Return Values:
  262.  Errors:
  263.  See Also:
  264. \*____________________________________________________________________________*/
  265. PUBLIC_PIAPI int HTTPCore_relativeToAbsolutePath( const char *pRelative,
  266.         Pi3String *pResult );
  267.  
  268. /*____________________________________________________________________________*\
  269.  *
  270.  Name:
  271.     HTTPCore_logError
  272.  
  273.  Synopsis:
  274.     int HTTPCore_logError( PIHTTP *pPIHTTP, const char *pFormat, ... )
  275.  
  276.  Description:
  277.     This function is not yet documented.
  278.  
  279.  Notes:
  280.  Return Values:
  281.  Errors:
  282.  See Also:
  283. \*____________________________________________________________________________*/
  284. PUBLIC_PIAPI int HTTPCore_logError( PIHTTP *pPIHTTP, const char *pFormat, ... );
  285.  
  286. /*____________________________________________________________________________*\
  287.  *
  288.  Name:
  289.     HTTPCore_logDebug
  290.  
  291.  Synopsis:
  292.     int HTTPCore_logDebug( int iLevel, const char *pFormat, ... )
  293.  
  294.  Description:
  295.     This function is not yet documented.
  296.  
  297.  Notes:
  298.  Return Values:
  299.  Errors:
  300.  See Also:
  301. \*____________________________________________________________________________*/
  302. PUBLIC_PIAPI int HTTPCore_logDebug( int iLevel, const char *pFormat, ... );
  303.  
  304. /*____________________________________________________________________________*\
  305.  *
  306.  Name:
  307.     HTTPCore_executePhase
  308.  
  309.  Synopsis:
  310.     int HTTPCore_executePhase( PIHTTP *pPIHTTP,
  311.         PIObject *(* nextHandler)(void *), void *pArg)
  312.  
  313.  Description:
  314.     This function is not yet documented.
  315.  
  316.  Notes:
  317.  Return Values:
  318.  Errors:
  319.  See Also:
  320. \*____________________________________________________________________________*/
  321. PUBLIC_PIAPI int HTTPCore_executePhase( PIHTTP *pPIHTTP,
  322.         PIObject *(* nextHandler)(void *), void *pArg);
  323.  
  324. /*____________________________________________________________________________*\
  325.  *
  326.  Name:
  327.     HTTPCore_dispatch
  328.  
  329.  Synopsis:
  330.     int HTTPCore_dispatch( PIHTTP *pPIHTTP, int iStartPhase, int iEndPhase )
  331.  
  332.  Description:
  333.     This function is not yet documented.
  334.  
  335.  Notes:
  336.  Return Values:
  337.  Errors:
  338.  See Also:
  339. \*____________________________________________________________________________*/
  340. PUBLIC_PIAPI int HTTPCore_dispatch( PIHTTP *pPIHTTP, int iStartPhase,
  341.         int iEndPhase );
  342.  
  343. /*____________________________________________________________________________*\
  344.  *
  345.  Name:
  346.     HTTPCore_debugEnabled
  347.  
  348.  Synopsis:
  349.     int HTTPCore_debugEnabled()
  350.  
  351.  Description:
  352.     This function is not yet documented.
  353.  
  354.  Notes:
  355.  Return Values:
  356.  Errors:
  357.  See Also:
  358. \*____________________________________________________________________________*/
  359. PUBLIC_PIAPI int HTTPCore_debugEnabled();
  360.  
  361. #endif /* HTTPCORE_H_ */
  362.  
  363.