http_client_misc.h
Go to the documentation of this file.
1 /**
2  * @file http_client_misc.h
3  * @brief Helper functions for HTTP client
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.0
29  **/
30 
31 #ifndef _HTTP_CLIENT_MISC_H
32 #define _HTTP_CLIENT_MISC_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "http/http_client.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //HTTP client related functions
45  HttpClientState newState);
46 
48  HttpRequestState newState);
49 
51 
53 
55  size_t length);
56 
58  size_t length);
59 
61  const char_t *value);
62 
64  const char_t *value);
65 
67  const char_t *value);
68 
70  size_t length);
71 
73 
74 //C++ guard
75 #ifdef __cplusplus
76 }
77 #endif
78 
79 #endif
char char_t
Definition: compiler_port.h:48
error_t
Error codes.
Definition: error.h:43
HTTP client (HyperText Transfer Protocol)
#define HttpClientContext
Definition: http_client.h:198
HttpClientState
HTTP client states.
Definition: http_client.h:211
error_t httpClientParseHeaderField(HttpClientContext *context, char_t *line, size_t length)
Parse HTTP response header field.
error_t httpClientParseContentLengthField(HttpClientContext *context, const char_t *value)
Parse Content-Length header field.
error_t httpClientFormatRequestHeader(HttpClientContext *context)
Format default HTTP request header.
error_t httpClientFormatChunkSize(HttpClientContext *context, size_t length)
Format chunk-size field.
error_t httpClientParseConnectionField(HttpClientContext *context, const char_t *value)
Parse Connection header field.
void httpClientChangeState(HttpClientContext *context, HttpClientState newState)
Update HTTP client state.
error_t httpClientParseStatusLine(HttpClientContext *context, char_t *line, size_t length)
Parse HTTP status line.
void httpClientChangeRequestState(HttpClientContext *context, HttpRequestState newState)
Update HTTP request state.
error_t httpClientParseChunkSize(HttpClientContext *context, char_t *line, size_t length)
Parse chunk-size field.
error_t httpClientParseTransferEncodingField(HttpClientContext *context, const char_t *value)
Parse Transfer-Encoding header field.
error_t httpClientCheckTimeout(HttpClientContext *context)
Determine whether a timeout error has occurred.
HttpRequestState
HTTP request states.
Definition: http_common.h:110
TCP/IP stack core.
uint8_t length
Definition: tcp.h:368
uint8_t value[]
Definition: tcp.h:369