web_socket_frame.c File Reference

WebSocket frame parsing and formatting. More...

Go to the source code of this file.

Macros

#define TRACE_LEVEL   WEB_SOCKET_TRACE_LEVEL
 

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

Copyright (C) 2010-2018 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
1.9.0

Definition in file web_socket_frame.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   WEB_SOCKET_TRACE_LEVEL

Definition at line 30 of file web_socket_frame.c.

Function Documentation

◆ webSocketFormatCloseFrame()

error_t webSocketFormatCloseFrame ( WebSocket webSocket)

Format a Close frame.

Parameters
[in]webSocketHandle to a WebSocket
Returns
Error code

Definition at line 434 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]webSocketHandle to a WebSocket
[in]finFIN flag
[in]typeFrame type
[in]payloadLenLength of the payload data
Returns
Error code

Definition at line 53 of file web_socket_frame.c.

◆ webSocketParseFrameHeader()

error_t webSocketParseFrameHeader ( WebSocket webSocket,
const WebSocketFrame frame,
WebSocketFrameType type 
)

Parse WebSocket frame header.

Parameters
[in]webSocketHandle to a WebSocket
[in]framePointer to the WebSocket frame header
[out]typeFrame type
Returns
Error code

Definition at line 177 of file web_socket_frame.c.