web_socket_frame.h File Reference

WebSocket frame parsing and formatting. More...

#include "core/net.h"
#include "web_socket/web_socket.h"

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. More...
error_t	webSocketParseFrameHeader (WebSocket *webSocket, const WebSocketFrame *frame, WebSocketFrameType *type)
	Parse WebSocket frame header. More...
error_t	webSocketFormatCloseFrame (WebSocket *webSocket)
	Format a Close frame. More...

Detailed Description

WebSocket frame parsing and formatting.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2024 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.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.4.4

Definition in file web_socket_frame.h.

Function Documentation

webSocketFormatCloseFrame()

error_t webSocketFormatCloseFrame

(

WebSocket *

webSocket

)

Format a Close frame.

Parameters

[in]

webSocket

Handle to a WebSocket

Returns

Error code

Definition at line 448 of file web_socket_frame.c.

webSocketFormatFrameHeader()

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 55 of file web_socket_frame.c.

webSocketParseFrameHeader()

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 179 of file web_socket_frame.c.