http_client_transport.h
Go to the documentation of this file.
1 /**
2  * @file http_client_transport.h
3  * @brief Transport protocol abstraction layer
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2019 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 1.9.2
29  **/
30 
31 #ifndef _HTTP_CLIENT_TRANSPORT_H
32 #define _HTTP_CLIENT_TRANSPORT_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 
47  const IpAddr *serverIpAddr, uint16_t serverPort);
48 
51 
52 error_t httpClientSendData(HttpClientContext *context, const void *data,
53  size_t length, size_t *written, uint_t flags);
54 
56  size_t size, size_t *received, uint_t flags);
57 
58 //C++ guard
59 #ifdef __cplusplus
60  }
61 #endif
62 
63 #endif
error_t httpClientShutdownConnection(HttpClientContext *context)
Shutdown network connection.
uint8_t flags
Definition: tcp.h:314
TCP/IP stack core.
#define HttpClientContext
Definition: http_client.h:205
error_t httpClientEstablishConnection(HttpClientContext *context, const IpAddr *serverIpAddr, uint16_t serverPort)
Establish network connection.
error_t httpClientReceiveData(HttpClientContext *context, void *data, size_t size, size_t *received, uint_t flags)
Receive data using the relevant transport protocol.
IP network address.
Definition: ip.h:59
error_t httpClientOpenConnection(HttpClientContext *context)
Open network connection.
void httpClientCloseConnection(HttpClientContext *context)
Close network connection.
error_t
Error codes.
Definition: error.h:42
unsigned int uint_t
Definition: compiler_port.h:45
uint8_t data[]
Definition: dtls_misc.h:169
error_t httpClientSendData(HttpClientContext *context, const void *data, size_t length, size_t *written, uint_t flags)
Send data using the relevant transport protocol.
uint8_t length
Definition: dtls_misc.h:142
HTTP client (HyperText Transfer Protocol)