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  * 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_FRAME_H
30 #define _WEB_SOCKET_FRAME_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
44 
46  const WebSocketFrame *frame, WebSocketFrameType *type);
47 
49 
50 //C++ guard
51 #ifdef __cplusplus
52  }
53 #endif
54 
55 #endif
uint8_t payloadLen
Definition: ipv6.h:341
error_t webSocketFormatCloseFrame(WebSocket *webSocket)
Format a Close frame.
TCP/IP stack core.
#define WebSocket
Definition: web_socket.h:175
char_t type
WebSocketFrameType
WebSocket frame types.
Definition: web_socket.h:260
__start_packed struct @303 WebSocketFrame
WebSocket frame.
error_t webSocketParseFrameHeader(WebSocket *webSocket, const WebSocketFrame *frame, WebSocketFrameType *type)
Parse WebSocket frame header.
error_t webSocketFormatFrameHeader(WebSocket *webSocket, bool_t fin, WebSocketFrameType type, size_t payloadLen)
Format WebSocket frame header.
uint8_t fin
Definition: web_socket.h:313
error_t
Error codes.
Definition: error.h:40
int bool_t
Definition: compiler_port.h:47
WebSocket API (client and server)