web_socket_frame.h
Go to the documentation of this file.
1 /**
2  * @file web_socket_frame.h
3  * @brief WebSocket frame parsing and formatting
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.6
29  **/
30 
31 #ifndef _WEB_SOCKET_FRAME_H
32 #define _WEB_SOCKET_FRAME_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "web_socket/web_socket.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //WebSocket related functions
46 
48  const WebSocketFrame *frame, WebSocketFrameType *type);
49 
51 
52 //C++ guard
53 #ifdef __cplusplus
54 }
55 #endif
56 
57 #endif
error_t webSocketFormatCloseFrame(WebSocket *webSocket)
Format a Close frame.
int bool_t
Definition: compiler_port.h:49
WebSocket API (client and server)
__start_packed struct @300 WebSocketFrame
WebSocket frame.
char_t type
error_t
Error codes.
Definition: error.h:42
WebSocketFrameType
WebSocket frame types.
Definition: web_socket.h:262
#define WebSocket
Definition: web_socket.h:177
error_t webSocketParseFrameHeader(WebSocket *webSocket, const WebSocketFrame *frame, WebSocketFrameType *type)
Parse WebSocket frame header.
uint8_t fin
Definition: web_socket.h:315
uint8_t payloadLen
Definition: ipv6.h:343
error_t webSocketFormatFrameHeader(WebSocket *webSocket, bool_t fin, WebSocketFrameType type, size_t payloadLen)
Format WebSocket frame header.
TCP/IP stack core.