sf_wifi_qca4010_socket_api_t Struct Reference

#include <sf_wifi_qca4010_socket_api.h>

Data Fields
ssp_err_t(*	open )(sf_wifi_qca4010_socket_ctrl_t *p_ctrl, sf_wifi_qca4010_socket_cfg_t const *const p_cfg)
	Open lower level driver. More...
ssp_err_t(*	close )(sf_wifi_qca4010_socket_ctrl_t *const p_ctrl)
	Close lower level driver. More...
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)
	Gets version and stores it in provided pointer p_version. More...
ssp_err_t(*	socketCreate )(sf_wifi_qca4010_socket_ctrl_t *p_ctrl, uint8_t socket_no, sf_wifi_socket_type_t type, uint8_t ipversion)
	Create a socket. More...
ssp_err_t(*	socketConnect )(sf_wifi_qca4010_socket_ctrl_t *p_ctrl, uint8_t socket_no, const struct sockaddr *p_serv_addr, socklen_t addrlen)
	Connect to socket. More...
ssp_err_t(*	socketDisconnect )(sf_wifi_qca4010_socket_ctrl_t *p_ctrl, uint8_t socket_no)
	Disconnect socket. More...
ssp_err_t(*	socketSend )(sf_wifi_qca4010_socket_ctrl_t *p_ctrl, uint8_t socket_no, const uint8_t *p_data, uint32_t length, uint32_t timeout_ms)
	Send data to connected socket. More...
ssp_err_t(*	socketRecv )(sf_wifi_qca4010_socket_ctrl_t *p_ctrl, uint8_t socket_no, uint8_t *const p_data, uint32_t length, uint32_t timeout_ms)
	Receive data from connected socket. More...
ssp_err_t(*	socketStatusGet )(sf_wifi_qca4010_socket_ctrl_t *p_ctrl, uint8_t socket_no, uint32_t *p_socket_status)
	Get Socket status. More...

Detailed Description

Socket Interface API

Field Documentation

close

ssp_err_t(* sf_wifi_qca4010_socket_api_t::close) (sf_wifi_qca4010_socket_ctrl_t *const p_ctrl)

Close lower level driver.

Parameters

[in,out]

p_ctrl

Pointer to the control block

open

ssp_err_t(* sf_wifi_qca4010_socket_api_t::open) (sf_wifi_qca4010_socket_ctrl_t *p_ctrl, sf_wifi_qca4010_socket_cfg_t const *const p_cfg)

Open lower level driver.

Parameters

[in,out]	p_ctrl	Pointer to user-provided storage for the control block.
[in]	p_cfg	Pointer to configuration structure.

socketConnect

ssp_err_t(* sf_wifi_qca4010_socket_api_t::socketConnect) (sf_wifi_qca4010_socket_ctrl_t *p_ctrl, uint8_t socket_no, const struct sockaddr *p_serv_addr, socklen_t addrlen)

Connect to socket.

Parameters

[in]	p_ctrl	pointer to control block
[in]	socket_no	Socket ID number
[in]	p_serv_addr	IP address to connect
[in]	addrlen	Size of socket address structure

socketCreate

ssp_err_t(* sf_wifi_qca4010_socket_api_t::socketCreate) (sf_wifi_qca4010_socket_ctrl_t *p_ctrl, uint8_t socket_no, sf_wifi_socket_type_t type, uint8_t ipversion)

Create a socket.

Parameters

[in]	p_ctrl	pointer to control block
[in]	socket_no	Socket ID number
[in]	type	TCP/UDP socket
[in]	ipversion	Protocol version

socketDisconnect

ssp_err_t(* sf_wifi_qca4010_socket_api_t::socketDisconnect) (sf_wifi_qca4010_socket_ctrl_t *p_ctrl, uint8_t socket_no)

Disconnect socket.

Parameters

[in]	p_ctrl	pointer to control block
[in]	socket_no	Socket ID number

socketRecv

ssp_err_t(* sf_wifi_qca4010_socket_api_t::socketRecv) (sf_wifi_qca4010_socket_ctrl_t *p_ctrl, uint8_t socket_no, uint8_t *const p_data, uint32_t length, uint32_t timeout_ms)

Receive data from connected socket.

Parameters

[in]	p_ctrl	pointer to control block
[in]	socket_no	Socket ID number
[out]	p_data	Data Receive buffer
[in]	length	Data length to be received
[in]	timeout_ms	timeout in milliseconds

socketSend

ssp_err_t(* sf_wifi_qca4010_socket_api_t::socketSend) (sf_wifi_qca4010_socket_ctrl_t *p_ctrl, uint8_t socket_no, const uint8_t *p_data, uint32_t length, uint32_t timeout_ms)

Send data to connected socket.

Parameters

[in]	p_ctrl	pointer to control block
[in]	socket_no	Socket ID number
[in]	p_data	send buffer
[in]	length	Data length to be sent
[in]	timeout_ms	timeout in milliseconds

socketStatusGet

ssp_err_t(* sf_wifi_qca4010_socket_api_t::socketStatusGet) (sf_wifi_qca4010_socket_ctrl_t *p_ctrl, uint8_t socket_no, uint32_t *p_socket_status)

Get Socket status.

Parameters

[in]	p_ctrl	pointer to control block
[in]	socket_no	Socket ID number
[out]	p_socket_status	Pointer to an integer to hold the socket return status

versionGet

ssp_err_t(* sf_wifi_qca4010_socket_api_t::versionGet) (ssp_version_t *const p_version)

Gets version and stores it in provided pointer p_version.

Parameters

[out]

p_version

pointer to memory location to return version number

---

The documentation for this struct was generated from the following file:

• sf_wifi_qca4010_socket_api.h