sf_cellular_socket_api_t Struct Reference

#include <sf_cellular_socket_api.h>

Data Fields
ssp_err_t(*	open )(sf_cellular_socket_ctrl_t *p_ctrl, sf_cellular_socket_cfg_t const *const p_cfg)
	Pointer to function which initializes the network interface for data transfers Initial driver configuration, enable the driver link, enable interrupts and make device ready for data transfer. More...
ssp_err_t(*	close )(sf_cellular_socket_ctrl_t *const p_ctrl)
	Pointer to function which un-initialize the network interface and may put it in low power mode or power it off. Close the driver, disable the driver link, disable interrupt. 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(*	ping )(sf_cellular_socket_ctrl_t *const p_ctrl, ULONG *p_ip_addr, uint32_t count, uint32_t interval_ms)

Detailed Description

Socket Interface API

Field Documentation

close

ssp_err_t(* sf_cellular_socket_api_t::close) (sf_cellular_socket_ctrl_t *const p_ctrl)

Pointer to function which un-initialize the network interface and may put it in low power mode or power it off. Close the driver, disable the driver link, disable interrupt.

Parameters

[in,out]

p_ctrl

Pointer to the control block for the Cellular module Socket interface.

open

ssp_err_t(* sf_cellular_socket_api_t::open) (sf_cellular_socket_ctrl_t *p_ctrl, sf_cellular_socket_cfg_t const *const p_cfg)

Pointer to function which initializes the network interface for data transfers Initial driver configuration, enable the driver link, enable interrupts and make device ready for data transfer.

Parameters

[in,out]	p_ctrl	Pointer to the control block for the Cellular module Socket interface.
[in]	p_cfg	Pointer to Cellular Socket interface configuration structure.

ping

ssp_err_t(* sf_cellular_socket_api_t::ping) (sf_cellular_socket_ctrl_t *const p_ctrl, ULONG *p_ip_addr, uint32_t count, uint32_t interval_ms)

Pointer to a function which is used to ping the IP address.

Parameters

[in]	p_ctrl	Pointer to the control block
[in]	p_ip_addr	Pointer to IP address to ping
[in]	count	Number of ping attempts
[in]	interval_ms	Interval between ping attempts

versionGet

ssp_err_t(* sf_cellular_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 SSP Version structure

---

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

• sf_cellular_socket_api.h