web_socket_misc.h
Go to the documentation of this file.
1 /**
2  * @file web_socket_misc.h
3  * @brief Helper functions for WebSockets
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_MISC_H
32 #define _WEB_SOCKET_MISC_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 
44 /**
45  * @brief HTTP status code
46  **/
47 
48 typedef struct
49 {
51  const char_t message[28];
53 
54 
55 //WebSocket related functions
56 void webSocketChangeState(WebSocket *webSocket, WebSocketState newState);
57 
62 
64 
65 error_t webSocketFormatClientHandshake(WebSocket *webSocket, uint16_t serverPort);
67 
70 
73 
76 
79 
81 
83  char_t *output, size_t outputSize);
84 
86  const uint8_t *data, size_t length, size_t remaining);
87 
88 //C++ guard
89 #ifdef __cplusplus
90 }
91 #endif
92 
93 #endif
uint8_t length
Definition: dtls_misc.h:149
error_t webSocketGenerateServerKey(WebSocket *webSocket)
Generate server's key.
HTTP status code.
int bool_t
Definition: compiler_port.h:49
error_t webSocketParseHeaderField(WebSocket *webSocket, char_t *line)
Parse a header field.
WebSocket API (client and server)
error_t webSocketGenerateClientKey(WebSocket *webSocket)
Generate client's key.
error_t webSocketVerifyServerKey(WebSocket *webSocket)
Verify server's key.
error_t webSocketVerifyClientHandshake(WebSocket *webSocket)
Verify client's handshake.
error_t webSocketFormatErrorResponse(WebSocket *webSocket, uint_t statusCode, const char_t *message)
Format HTTP error response.
error_t
Error codes.
Definition: error.h:42
uint16_t statusCode
bool_t webSocketCheckStatusCode(uint16_t statusCode)
Check whether a status code is valid.
UTF-8 decoding context.
Definition: web_socket.h:414
error_t webSocketParseRequestLine(WebSocket *webSocket, char_t *line)
Parse the Request-Line of the client's handshake.
error_t webSocketFormatServerHandshake(WebSocket *webSocket)
Format server's handshake.
bool_t webSocketCheckUtf8Stream(WebSocketUtf8Context *context, const uint8_t *data, size_t length, size_t remaining)
Check whether a an UTF-8 stream is valid.
error_t webSocketParseStatusLine(WebSocket *webSocket, char_t *line)
Parse the Status-Line of the server's handshake.
WebSocketState
WebSocket states.
Definition: web_socket.h:224
#define WebSocket
Definition: web_socket.h:177
error_t webSocketFormatClientHandshake(WebSocket *webSocket, uint16_t serverPort)
Format client's handshake.
char char_t
Definition: compiler_port.h:43
error_t webSocketVerifyServerHandshake(WebSocket *webSocket)
Verify server's handshake.
error_t webSocketParseHandshake(WebSocket *webSocket)
Parse client or server handshake.
void webSocketChangeState(WebSocket *webSocket, WebSocketState newState)
Update WebSocket state.
uint8_t message[]
Definition: chap.h:152
error_t webSocketVerifyClientKey(WebSocket *webSocket)
Verify client's key.
void webSocketParseConnectionField(WebSocket *webSocket, char_t *value)
Parse Connection header field.
error_t webSocketDecodePercentEncodedString(const char_t *input, char_t *output, size_t outputSize)
Decode a percent-encoded string.
uint8_t value[]
Definition: dtls_misc.h:150
unsigned int uint_t
Definition: compiler_port.h:45
TCP/IP stack core.
uint8_t data[]
Definition: dtls_misc.h:176