web_socket_transport.h
Go to the documentation of this file.
1 /**
2  * @file web_socket_transport.h
3  * @brief WebSocket transport layer
4  *
5  * @section License
6  *
7  * Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.
8  *
9  * This file is part of CycloneTCP Open.
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24  *
25  * @author Oryx Embedded SARL (www.oryx-embedded.com)
26  * @version 1.9.0
27  **/
28 
29 #ifndef _WEB_SOCKET_TRANSPORT_H
30 #define _WEB_SOCKET_TRANSPORT_H
31 
32 //Dependencies
33 #include "core/net.h"
34 #include "web_socket/web_socket.h"
35 
36 //C++ guard
37 #ifdef __cplusplus
38  extern "C" {
39 #endif
40 
41 //WebSocket related functions
43 
45  const IpAddr *serverIpAddr, uint16_t serverPort);
46 
48 void webSocketCloseConnection(WebSocket *webSocket);
49 
50 error_t webSocketSendData(WebSocket *webSocket, const void *data,
51  size_t length, size_t *written, uint_t flags);
52 
53 error_t webSocketReceiveData(WebSocket *webSocket, void *data,
54  size_t size, size_t *received, uint_t flags);
55 
56 //C++ guard
57 #ifdef __cplusplus
58  }
59 #endif
60 
61 #endif
uint8_t flags
Definition: tcp.h:312
TCP/IP stack core.
error_t webSocketSendData(WebSocket *webSocket, const void *data, size_t length, size_t *written, uint_t flags)
Send data using the relevant transport protocol.
#define WebSocket
Definition: web_socket.h:175
error_t webSocketReceiveData(WebSocket *webSocket, void *data, size_t size, size_t *received, uint_t flags)
Receive data using the relevant transport protocol.
IP network address.
Definition: ip.h:57
error_t webSocketShutdownConnection(WebSocket *webSocket)
Shutdown network connection.
error_t
Error codes.
Definition: error.h:40
unsigned int uint_t
Definition: compiler_port.h:43
uint8_t data[]
Definition: dtls_misc.h:167
error_t webSocketOpenConnection(WebSocket *webSocket)
Open network connection.
void webSocketCloseConnection(WebSocket *webSocket)
Close network connection.
uint8_t length
Definition: dtls_misc.h:140
WebSocket API (client and server)
error_t webSocketEstablishConnection(WebSocket *webSocket, const IpAddr *serverIpAddr, uint16_t serverPort)
Establish network connection.