1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3<title>uIP 1.0: apps/webserver/httpd-cgi.h Source File</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5<link href="tabs.css" rel="stylesheet" type="text/css"> 6</head><body> 7<!-- Generated by Doxygen 1.4.6 --> 8<div class="tabs"> 9 <ul> 10 <li><a href="main.html"><span>Main Page</span></a></li> 11 <li><a href="modules.html"><span>Modules</span></a></li> 12 <li><a href="classes.html"><span>Data Structures</span></a></li> 13 <li id="current"><a href="files.html"><span>Files</span></a></li> 14 <li><a href="examples.html"><span>Examples</span></a></li> 15 </ul></div> 16<div class="tabs"> 17 <ul> 18 <li><a href="files.html"><span>File List</span></a></li> 19 <li><a href="globals.html"><span>Globals</span></a></li> 20 </ul></div> 21<h1>apps/webserver/httpd-cgi.h</h1><a href="a00113.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**</span> 22<a name="l00002"></a>00002 <span class="comment"> * \addtogroup httpd</span> 23<a name="l00003"></a>00003 <span class="comment"> * @{</span> 24<a name="l00004"></a>00004 <span class="comment"> */</span> 25<a name="l00005"></a>00005 <span class="comment"></span> 26<a name="l00006"></a>00006 <span class="comment">/**</span> 27<a name="l00007"></a>00007 <span class="comment"> * \file</span> 28<a name="l00008"></a>00008 <span class="comment"> * Web server script interface header file</span> 29<a name="l00009"></a>00009 <span class="comment"> * \author</span> 30<a name="l00010"></a>00010 <span class="comment"> * Adam Dunkels <[email protected]></span> 31<a name="l00011"></a>00011 <span class="comment"> *</span> 32<a name="l00012"></a>00012 <span class="comment"> */</span> 33<a name="l00013"></a>00013 34<a name="l00014"></a>00014 35<a name="l00015"></a>00015 36<a name="l00016"></a>00016 <span class="comment">/*</span> 37<a name="l00017"></a>00017 <span class="comment"> * Copyright (c) 2001, Adam Dunkels.</span> 38<a name="l00018"></a>00018 <span class="comment"> * All rights reserved.</span> 39<a name="l00019"></a>00019 <span class="comment"> *</span> 40<a name="l00020"></a>00020 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span> 41<a name="l00021"></a>00021 <span class="comment"> * modification, are permitted provided that the following conditions</span> 42<a name="l00022"></a>00022 <span class="comment"> * are met:</span> 43<a name="l00023"></a>00023 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span> 44<a name="l00024"></a>00024 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span> 45<a name="l00025"></a>00025 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span> 46<a name="l00026"></a>00026 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span> 47<a name="l00027"></a>00027 <span class="comment"> * documentation and/or other materials provided with the distribution.</span> 48<a name="l00028"></a>00028 <span class="comment"> * 3. The name of the author may not be used to endorse or promote</span> 49<a name="l00029"></a>00029 <span class="comment"> * products derived from this software without specific prior</span> 50<a name="l00030"></a>00030 <span class="comment"> * written permission.</span> 51<a name="l00031"></a>00031 <span class="comment"> *</span> 52<a name="l00032"></a>00032 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS</span> 53<a name="l00033"></a>00033 <span class="comment"> * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span> 54<a name="l00034"></a>00034 <span class="comment"> * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span> 55<a name="l00035"></a>00035 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY</span> 56<a name="l00036"></a>00036 <span class="comment"> * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span> 57<a name="l00037"></a>00037 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE</span> 58<a name="l00038"></a>00038 <span class="comment"> * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span> 59<a name="l00039"></a>00039 <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span> 60<a name="l00040"></a>00040 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span> 61<a name="l00041"></a>00041 <span class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span> 62<a name="l00042"></a>00042 <span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span> 63<a name="l00043"></a>00043 <span class="comment"> *</span> 64<a name="l00044"></a>00044 <span class="comment"> * This file is part of the uIP TCP/IP stack.</span> 65<a name="l00045"></a>00045 <span class="comment"> *</span> 66<a name="l00046"></a>00046 <span class="comment"> * $Id: httpd-cgi.h,v 1.2 2006/06/11 21:46:38 adam Exp $</span> 67<a name="l00047"></a>00047 <span class="comment"> *</span> 68<a name="l00048"></a>00048 <span class="comment"> */</span> 69<a name="l00049"></a>00049 70<a name="l00050"></a>00050 <span class="preprocessor">#ifndef __HTTPD_CGI_H__</span> 71<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor">#define __HTTPD_CGI_H__</span> 72<a name="l00052"></a>00052 <span class="preprocessor"></span> 73<a name="l00053"></a>00053 <span class="preprocessor">#include "<a class="code" href="a00127.html">psock.h</a>"</span> 74<a name="l00054"></a>00054 <span class="preprocessor">#include "httpd.h"</span> 75<a name="l00055"></a>00055 76<a name="l00056"></a>00056 <span class="keyword">typedef</span> <a class="code" href="a00142.html#g3d4c8bd4aada659eb34f5d2ffd3e7901">PT_THREAD</a>((* httpd_cgifunction)(<span class="keyword">struct</span> <a class="code" href="a00080.html">httpd_state</a> *, <span class="keywordtype">char</span> *)); 77<a name="l00057"></a>00057 78<a name="l00058"></a>00058 httpd_cgifunction <a class="code" href="a00164.html#ge6f849e94cf6e214be8ffa9a548ecfcd">httpd_cgi</a>(<span class="keywordtype">char</span> *name); 79<a name="l00059"></a>00059 80<a name="l00060"></a><a class="code" href="a00079.html">00060</a> <span class="keyword">struct </span><a class="code" href="a00079.html">httpd_cgi_call</a> { 81<a name="l00061"></a><a class="code" href="a00079.html#9a84c69ec5a4705ccb1ca99fcd120add">00061</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="a00079.html#9a84c69ec5a4705ccb1ca99fcd120add">name</a>; 82<a name="l00062"></a><a class="code" href="a00079.html#1513a9e88921750d2a611b518f6fc207">00062</a> <span class="keyword">const</span> httpd_cgifunction <a class="code" href="a00079.html#1513a9e88921750d2a611b518f6fc207">function</a>; 83<a name="l00063"></a>00063 }; 84<a name="l00064"></a>00064 <span class="comment"></span> 85<a name="l00065"></a>00065 <span class="comment">/**</span> 86<a name="l00066"></a>00066 <span class="comment"> * \brief HTTPD CGI function declaration</span> 87<a name="l00067"></a>00067 <span class="comment"> * \param name The C variable name of the function</span> 88<a name="l00068"></a>00068 <span class="comment"> * \param str The string name of the function, used in the script file</span> 89<a name="l00069"></a>00069 <span class="comment"> * \param function A pointer to the function that implements it</span> 90<a name="l00070"></a>00070 <span class="comment"> *</span> 91<a name="l00071"></a>00071 <span class="comment"> * This macro is used for declaring a HTTPD CGI</span> 92<a name="l00072"></a>00072 <span class="comment"> * function. This function is then added to the list of</span> 93<a name="l00073"></a>00073 <span class="comment"> * HTTPD CGI functions with the httpd_cgi_add() function.</span> 94<a name="l00074"></a>00074 <span class="comment"> *</span> 95<a name="l00075"></a>00075 <span class="comment"> * \hideinitializer</span> 96<a name="l00076"></a>00076 <span class="comment"> */</span> 97<a name="l00077"></a><a class="code" href="a00164.html#g1dbc635a2924806f42d7e3273a6a69b5">00077</a> <span class="preprocessor">#define HTTPD_CGI_CALL(name, str, function) \</span> 98<a name="l00078"></a>00078 <span class="preprocessor">static PT_THREAD(function(struct httpd_state *, char *)); \</span> 99<a name="l00079"></a>00079 <span class="preprocessor">static const struct httpd_cgi_call name = {str, function}</span> 100<a name="l00080"></a>00080 <span class="preprocessor"></span> 101<a name="l00081"></a>00081 <span class="keywordtype">void</span> httpd_cgi_init(<span class="keywordtype">void</span>); 102<a name="l00082"></a>00082 <span class="preprocessor">#endif </span><span class="comment">/* __HTTPD_CGI_H__ */</span> 103<a name="l00083"></a>00083 <span class="comment"></span> 104<a name="l00084"></a>00084 <span class="comment">/** @} */</span> 105</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:01 2006 for uIP 1.0 by 106<a href="http://www.doxygen.org/index.html"> 107<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> 108</body> 109</html> 110
