web_socket_transport.c File Reference

WebSocket transport layer. More...

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

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   WEB_SOCKET_TRACE_LEVEL

Functions
error_t	webSocketOpenConnection (WebSocket *webSocket)
	Open network connection. More...
error_t	webSocketEstablishConnection (WebSocket *webSocket, const IpAddr *serverIpAddr, uint16_t serverPort)
	Establish network connection. More...
error_t	webSocketShutdownConnection (WebSocket *webSocket)
	Shutdown network connection. More...
void	webSocketCloseConnection (WebSocket *webSocket)
	Close network connection. More...
error_t	webSocketSendData (WebSocket *webSocket, const void *data, size_t length, size_t *written, uint_t flags)
	Send data using the relevant transport protocol. More...
error_t	webSocketReceiveData (WebSocket *webSocket, void *data, size_t size, size_t *received, uint_t flags)
	Receive data using the relevant transport protocol. More...

Detailed Description

WebSocket transport layer.

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.0

Definition in file web_socket_transport.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   WEB_SOCKET_TRACE_LEVEL

Definition at line 32 of file web_socket_transport.c.

Function Documentation

webSocketCloseConnection()

void webSocketCloseConnection

(

WebSocket *

webSocket

)

Close network connection.

Parameters

[in]

webSocket

Handle to a WebSocket

Definition at line 216 of file web_socket_transport.c.

webSocketEstablishConnection()

error_t webSocketEstablishConnection	(	WebSocket *	webSocket,
		const IpAddr *	serverIpAddr,
		uint16_t	serverPort
	)

Establish network connection.

Parameters

[in]	webSocket	Handle to a WebSocket
[in]	serverIpAddr	IP address of the WebSocket server to connect to
[in]	serverPort	TCP port number that will be used to establish the connection

Returns

Error code

Definition at line 138 of file web_socket_transport.c.

webSocketOpenConnection()

error_t webSocketOpenConnection

(

WebSocket *

webSocket

)

Open network connection.

Parameters

[in]

webSocket

Handle to a WebSocket

Returns

Error code

Definition at line 50 of file web_socket_transport.c.

webSocketReceiveData()

error_t webSocketReceiveData	(	WebSocket *	webSocket,
		void *	data,
		size_t	size,
		size_t *	received,
		uint_t	flags
	)

Receive data using the relevant transport protocol.

Parameters

[in]	webSocket	Handle to a WebSocket
[out]	data	Buffer into which received data will be placed
[in]	size	Maximum number of bytes that can be received
[out]	received	Number of bytes that have been received
[in]	flags	Set of flags that influences the behavior of this function

Returns

Error code

Definition at line 284 of file web_socket_transport.c.

webSocketSendData()

error_t webSocketSendData	(	WebSocket *	webSocket,
		const void *	data,
		size_t	length,
		size_t *	written,
		uint_t	flags
	)

Send data using the relevant transport protocol.

Parameters

[in]	webSocket	Handle to a WebSocket
[in]	data	Pointer to a buffer containing the data to be transmitted
[in]	length	Number of bytes to be transmitted
[out]	written	Actual number of bytes written (optional parameter)
[in]	flags	Set of flags that influences the behavior of this function

Returns

Error code

Definition at line 250 of file web_socket_transport.c.

webSocketShutdownConnection()

error_t webSocketShutdownConnection

(

WebSocket *

webSocket

)

Shutdown network connection.

Parameters

[in]

webSocket

Handle to a WebSocket

Returns

Error code

Definition at line 170 of file web_socket_transport.c.