fnet_http.h

 /**************************************************************************

 *

 * Copyright 2011-2017 by Andrey Butok. FNET Community.

 * Copyright 2008-2010 by Andrey Butok. Freescale Semiconductor, Inc.

 *

 ***************************************************************************

 *

 * Licensed under the Apache License, Version 2.0 (the "License"); you may

 * not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 * http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 *

 ***************************************************************************

 *

 * FNET HTTP Server API.

 *

 ***************************************************************************/

 

 #ifndef _FNET_HTTP_H_

 

 #define _FNET_HTTP_H_

 

 #if FNET_CFG_HTTP || defined(__DOXYGEN__)

 

 /**************************************************************************/

 #if FNET_CFG_HTTP_VERSION_MAJOR /*HTTP/1.x*/

  #define FNET_HTTP_VERSION_MAJOR (1u)

 #else /*HTTP/0.9*/

  #define FNET_HTTP_VERSION_MAJOR (0u)

 #endif

 

 /**************************************************************************/

 #if FNET_CFG_HTTP_VERSION_MAJOR /* HTTP/1.x*/

  #define FNET_HTTP_VERSION_MINOR (0u)

 #else /*HTTP/0.9*/

  #define FNET_HTTP_VERSION_MINOR (9u)

 #endif

 

 

 #if FNET_CFG_HTTP_VERSION_MAJOR /* HTTP/1.x*/ || defined(__DOXYGEN__)

 

 /********************************************************************/

 typedef enum

 {

  FNET_HTTP_STATUS_CODE_NONE = 0,

  FNET_HTTP_STATUS_CODE_OK = 200,

  FNET_HTTP_STATUS_CODE_CREATED = 201,

  FNET_HTTP_STATUS_CODE_ACCEPTED = 202,

  FNET_HTTP_STATUS_CODE_NO_CONTENT = 204,

  FNET_HTTP_STATUS_CODE_MOVED_PERMANENTLY = 301,

  FNET_HTTP_STATUS_CODE_MOVED_TEMPORARILY = 302,

  FNET_HTTP_STATUS_CODE_NOT_MODIFIED = 304,

  FNET_HTTP_STATUS_CODE_BAD_REQUEST = 400,

  FNET_HTTP_STATUS_CODE_UNAUTHORIZED = 401,

  FNET_HTTP_STATUS_CODE_FORBIDDEN = 403,

  FNET_HTTP_STATUS_CODE_NOT_FOUND = 404,

  FNET_HTTP_STATUS_CODE_INTERNAL_SERVER_ERROR = 500,

  FNET_HTTP_STATUS_CODE_NOT_IMPLEMENTED = 501,

  FNET_HTTP_STATUS_CODE_BAD_GATEWAY = 502,

  FNET_HTTP_STATUS_CODE_SERVICE_UNAVAILABLE = 503

 } fnet_http_status_code_t;

 #endif

 

 #if (FNET_CFG_HTTP_TLS && FNET_CFG_TLS) || defined(__DOXYGEN__)

 /**************************************************************************/

 struct fnet_http_tls_params

 {

  const fnet_uint8_t *certificate_buffer;

  fnet_size_t certificate_buffer_size;

  const fnet_uint8_t *private_key_buffer;

  fnet_size_t private_key_buffer_size;

 };

 #endif

 

 /**************************************************************************/

 struct fnet_http_params

 {

  fnet_char_t *root_path;

  fnet_char_t *index_path;

  struct fnet_sockaddr address;

 #if FNET_CFG_HTTP_SSI || defined(__DOXYGEN__)

  const struct fnet_http_ssi *ssi_table;

 #endif

 #if FNET_CFG_HTTP_CGI || defined(__DOXYGEN__)

  const struct fnet_http_cgi *cgi_table;

 #endif

 #if (FNET_CFG_HTTP_AUTHENTICATION_BASIC && FNET_CFG_HTTP_VERSION_MAJOR) || defined(__DOXYGEN__)

  const struct fnet_http_auth *auth_table;

 #endif

 #if (FNET_CFG_HTTP_POST && FNET_CFG_HTTP_VERSION_MAJOR) || defined(__DOXYGEN__)

  const struct fnet_http_post *post_table;

 #endif

 #if (FNET_CFG_HTTP_TLS && FNET_CFG_TLS) || defined(__DOXYGEN__)

  struct fnet_http_tls_params *tls_params;

 #endif

 };

 

 /**************************************************************************/

 typedef fnet_int32_t fnet_http_desc_t;

 

 /**************************************************************************/

 typedef fnet_int32_t fnet_http_session_t;

 

 #include "fnet_http_ssi.h"

 #include "fnet_http_cgi.h"

 #include "fnet_http_auth.h"

 #include "fnet_http_post.h"

 

 #if defined(__cplusplus)

 extern "C" {

 #endif

 

 /***************************************************************************/

 fnet_http_desc_t fnet_http_init( struct fnet_http_params *params);

 

 /***************************************************************************/

 void fnet_http_release(fnet_http_desc_t desc);

 

 /***************************************************************************/

 fnet_bool_t fnet_http_is_enabled(fnet_http_desc_t desc);

 

 /***************************************************************************/

 void fnet_http_query_unencode(fnet_uint8_t *dest, fnet_uint8_t *src);

 

 #if FNET_CFG_HTTP_VERSION_MAJOR /* HTTP/1.x*/ || defined(__DOXYGEN__)

 

 /**************************************************************************/

 void fnet_http_set_response_status_code (fnet_http_session_t session, fnet_http_status_code_t status_code);

 

 /**************************************************************************/

 void fnet_http_set_response_content_length (fnet_http_session_t session, fnet_size_t content_length);

 

 /**************************************************************************/

 void fnet_http_set_response_no_header (fnet_http_session_t session);

 

 #endif

 

 #if defined(__cplusplus)

 }

 #endif

 

 #endif /* FNET_CFG_HTTP */

 

 #endif