Embedded TCP/IP stack: fnet_http_cgi.h Source File

FNET

previous page next page
fnet_http_cgi.h
1 /**************************************************************************
2 *
3 * Copyright 2011-2016 by Andrey Butok. FNET Community.
4 * Copyright 2008-2010 by Andrey Butok. Freescale Semiconductor, Inc.
5 *
6 ***************************************************************************
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 *
20 ***************************************************************************
21 *
22 * FNET HTTP Server CGI API.
23 *
24 ***************************************************************************/
25 
26 #ifndef _FNET_HTTP_CGI_H_
27 
28 #define _FNET_HTTP_CGI_H_
29 
30 #if (FNET_CFG_HTTP && FNET_CFG_HTTP_CGI) || defined(__DOXYGEN__)
31 
35 /**************************************************************************/
41 #define FNET_HTTP_CGI_EXTENSION "cgi"
42 
43 /**************************************************************************/
72 typedef fnet_return_t(*fnet_http_cgi_handle_t)(fnet_http_session_t session, fnet_char_t *query, fnet_uint32_t *cookie);
73 
74 
75 /**************************************************************************/
111 typedef fnet_size_t (*fnet_http_cgi_send_t)(fnet_uint8_t *buffer, fnet_size_t buffer_size, fnet_bool_t *eof, fnet_uint32_t *cookie);
112 
113 /**************************************************************************/
124 struct fnet_http_cgi
125 {
126  fnet_char_t *name;
127  fnet_http_cgi_handle_t handle;
128  fnet_http_cgi_send_t send;
131 };
132 
135 #endif
136 
137 #endif
fnet_http_cgi_send_t
fnet_size_t(* fnet_http_cgi_send_t)(fnet_uint8_t *buffer, fnet_size_t buffer_size, fnet_bool_t *eof, fnet_uint32_t *cookie)
Callback function prototype of the CGI response function.
Definition: fnet_http_cgi.h:111
fnet_http_cgi
CGI callback function table.
Definition: fnet_http_cgi.h:124
fnet_return_t
fnet_return_t
General return codes, used by most of API functions.
Definition: fnet_stdlib.h:90
fnet_size_t
unsigned long fnet_size_t
Unsigned integer type representing the size in bytes.
Definition: fnet_stdlib.h:56
fnet_http_cgi::send
fnet_http_cgi_send_t send
Pointer to the CGI response function. This function actually creates dynamic content of the CGI respo...
Definition: fnet_http_cgi.h:128
fnet_http_session_t
fnet_int32_t fnet_http_session_t
HTTP session handle.
Definition: fnet_http.h:216
fnet_bool_t
fnet_bool_t
Boolean type.
Definition: fnet_stdlib.h:81
fnet_char_t
char fnet_char_t
Type representing the charecter.
Definition: fnet_stdlib.h:76
fnet_http_cgi::name
fnet_char_t * name
CGI file name.
Definition: fnet_http_cgi.h:126
fnet_http_cgi::handle
fnet_http_cgi_handle_t handle
Pointer to the CGI query handler. It's optional.
Definition: fnet_http_cgi.h:127
fnet_http_cgi_handle_t
fnet_return_t(* fnet_http_cgi_handle_t)(fnet_http_session_t session, fnet_char_t *query, fnet_uint32_t *cookie)
Callback function prototype of the CGI query handler.
Definition: fnet_http_cgi.h:72
© 2005-2018 by Andrey Butok. http://fnet.sourceforge.net
previous page start next page