web_socket_frame.h

00001 /**
00002  * @file web_socket_frame.h
00003  * @brief WebSocket frame parsing and formatting
00004  *
00005  * @section License
00006  *
00007  * Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.
00008  *
00009  * This file is part of CycloneTCP Open.
00010  *
00011  * This program is free software; you can redistribute it and/or
00012  * modify it under the terms of the GNU General Public License
00013  * as published by the Free Software Foundation; either version 2
00014  * of the License, or (at your option) any later version.
00015  *
00016  * This program is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU General Public License for more details.
00020  *
00021  * You should have received a copy of the GNU General Public License
00022  * along with this program; if not, write to the Free Software Foundation,
00023  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
00024  *
00025  * @author Oryx Embedded SARL (www.oryx-embedded.com)
00026  * @version 1.7.6
00027  **/
00028 
00029 #ifndef _WEB_SOCKET_FRAME_H
00030 #define _WEB_SOCKET_FRAME_H
00031 
00032 //Dependencies
00033 #include "core/net.h"
00034 #include "web_socket/web_socket.h"
00035 
00036 //WebSocket related functions
00037 error_t webSocketFormatFrameHeader(WebSocket *webSocket,
00038    bool_t fin, WebSocketFrameType type, size_t payloadLen);
00039 
00040 error_t webSocketParseFrameHeader(WebSocket *webSocket,
00041    const WebSocketFrame *frame, WebSocketFrameType *type);
00042 
00043 error_t webSocketFormatCloseFrame(WebSocket *webSocket);
00044 
00045 #endif
00046