TCP server comms

Functions
wiced_result_t	wiced_tcp_get_socket_state (wiced_tcp_socket_t *socket, wiced_socket_state_t *socket_state)
wiced_result_t	wiced_tcp_server_accept (wiced_tcp_server_t *tcp_server, wiced_tcp_socket_t *socket)
wiced_result_t	wiced_tcp_server_disconnect_socket (wiced_tcp_server_t *tcp_server, wiced_tcp_socket_t *socket)
wiced_result_t	wiced_tcp_server_disconnect_socket_with_timeout (wiced_tcp_server_t *tcp_server, wiced_tcp_socket_t *socket, uint32_t timeout_ms)
wiced_result_t	wiced_tcp_server_enable_tls (wiced_tcp_server_t *tcp_server, wiced_tls_identity_t *tls_identity)
wiced_result_t	wiced_tcp_server_start (wiced_tcp_server_t *tcp_server, wiced_interface_t interface, uint16_t port, uint16_t max_sockets, wiced_tcp_socket_callback_t connect_callback, wiced_tcp_socket_callback_t receive_callback, wiced_tcp_socket_callback_t disconnect_callback, void *arg)
wiced_result_t	wiced_tcp_server_stop (wiced_tcp_server_t *server)

Detailed Description

Functions for communication over TCP as a server

Function Documentation

wiced_tcp_get_socket_state()

wiced_result_t wiced_tcp_get_socket_state	(	wiced_tcp_socket_t *	socket,
		wiced_socket_state_t *	socket_state )

Get socket state

Parameters

[in]	socket	: Pointer to tcp socket to retrieve socket state from
[in]	state	: Socket state is returned here

Returns

wiced_result_t

wiced_tcp_server_accept()

wiced_result_t wiced_tcp_server_accept	(	wiced_tcp_server_t *	tcp_server,
		wiced_tcp_socket_t *	socket )

Server accepts incoming connection on specified socket

Parameters

[in]	tcp_server	: Pointer to TCP server structure
[in]	socket	: TCP socket structure

Returns

wiced_result_t

wiced_tcp_server_disconnect_socket()

wiced_result_t wiced_tcp_server_disconnect_socket	(	wiced_tcp_server_t *	tcp_server,
		wiced_tcp_socket_t *	socket )

Disconnect server socket using the default timeout

Parameters

[in]	tcp_server	: Pointer to TCP server structure
[in]	socket	: TCP socket structure

Returns

wiced_result_t

wiced_tcp_server_disconnect_socket_with_timeout()

wiced_result_t wiced_tcp_server_disconnect_socket_with_timeout	(	wiced_tcp_server_t *	tcp_server,
		wiced_tcp_socket_t *	socket,
		uint32_t	timeout_ms )

Disconnect server socket using the specified timeout

Parameters

[in]	tcp_server	: Pointer to TCP server structure
[in]	socket	: TCP socket structure
[in]	timeout_ms	: Timeout period in milliseconds

Returns

wiced_result_t

wiced_tcp_server_enable_tls()

wiced_result_t wiced_tcp_server_enable_tls	(	wiced_tcp_server_t *	tcp_server,
		wiced_tls_identity_t *	tls_identity )

Add TLS security to a TCP server ( all server sockets )

Parameters

[in]	tcp_server	: Pointer to TCP server structure
[in]	tls_identity	: A pointer to a wiced_tls_identity_t object

Returns

wiced_result_t

wiced_tcp_server_start()

wiced_result_t wiced_tcp_server_start	(	wiced_tcp_server_t *	tcp_server,
		wiced_interface_t	interface,
		uint16_t	port,
		uint16_t	max_sockets,
		wiced_tcp_socket_callback_t	connect_callback,
		wiced_tcp_socket_callback_t	receive_callback,
		wiced_tcp_socket_callback_t	disconnect_callback,
		void *	arg )

Initializes the TCP server, and creates and begins listening on specified port

Parameters

[in]	tcp_server	: Pointer to TCP server structure
[in]	interface	: The interface (AP or STA) for which the socket should be created
[in]	port	: TCP server listening port
[in]	max_sockets	: Specify maximum number of sockets server should support. Unused parameter in FreeRTOS-LwIP
[in]	connect_callback	: Listening socket connect callback
[in]	receive_callback	: Listening socket receive callback
[in]	disconnect_callback	Listening socket disconnect callback
[in]	arg	: Argument that will be passed to the callbacks

Returns

wiced_result_t

wiced_tcp_server_stop()

wiced_result_t wiced_tcp_server_stop

(

wiced_tcp_server_t *

server

)

Stop and tear down TCP server

Parameters

[in]

tcp_server

: Pointer to TCP server structure

Returns

wiced_result_t