Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
web_socket_frame.h File Reference
WebSocket frame parsing and formatting. More...
Go to the source code of this file.
Functions | |
| error_t | webSocketFormatFrameHeader (WebSocket *webSocket, bool_t fin, WebSocketFrameType type, size_t payloadLen) |
| Format WebSocket frame header. | |
| error_t | webSocketParseFrameHeader (WebSocket *webSocket, const WebSocketFrame *frame, WebSocketFrameType *type) |
| Parse WebSocket frame header. | |
| error_t | webSocketFormatCloseFrame (WebSocket *webSocket) |
| Format a Close frame. | |
Detailed Description
WebSocket frame parsing and formatting.
License
Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.
This file is part of CycloneTCP Open.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- Version:
- 1.7.6
Definition in file web_socket_frame.h.
Function Documentation
| error_t webSocketFormatCloseFrame | ( | WebSocket * | webSocket ) |
Format a Close frame.
- Parameters:
-
[in] webSocket Handle to a WebSocket
- Returns:
- Error code
Definition at line 434 of file web_socket_frame.c.
| error_t webSocketFormatFrameHeader | ( | WebSocket * | webSocket, |
| bool_t | fin, | ||
| WebSocketFrameType | type, | ||
| size_t | payloadLen | ||
| ) |
Format WebSocket frame header.
- Parameters:
-
[in] webSocket Handle to a WebSocket [in] fin FIN flag [in] type Frame type [in] payloadLen Length of the payload data
- Returns:
- Error code
Definition at line 53 of file web_socket_frame.c.
| error_t webSocketParseFrameHeader | ( | WebSocket * | webSocket, |
| const WebSocketFrame * | frame, | ||
| WebSocketFrameType * | type | ||
| ) |
Parse WebSocket frame header.
- Parameters:
-
[in] webSocket Handle to a WebSocket [in] frame Pointer to the WebSocket frame header [out] type Frame type
- Returns:
- Error code
Definition at line 177 of file web_socket_frame.c.
Generated on Tue Jul 12 2022 17:10:23 by
1.7.2