Andrew Reed / Mbed OS CITY1082-i2c_master_wifi_mqtt
Embed: (wiki syntax)

« Back to documentation index

cy_nw_helper.h File Reference

cy_nw_helper.h File Reference

This is a collection of network helper functions which would be used by various Cypress Middleware libraries. More...

Go to the source code of this file.

Data Structures

struct  cy_nw_ip_status_change_callback
 Network IP status change callback info. More...
struct  cy_nw_ip_address
 IP addr info. More...
struct  cy_nw_ip_mac
 MAC Address info. More...
struct  cy_nw_arp_cache_entry
 ARP Cache Entry info. More...
struct  cy_network_interface_t
 Network interface info structure. More...

Typedefs

typedef enum nw_ip_version cy_nw_ip_version_t
 IP version.
typedef void( cy_nw_ip_status_change_callback_func_t )(cy_nw_ip_interface_t iface, void *arg)
 Network IP status change callback function.
typedef struct
cy_nw_ip_status_change_callback 
cy_nw_ip_status_change_callback_t
 Network IP status change callback info.
typedef struct cy_nw_ip_address cy_nw_ip_address_t
 IP addr info.
typedef void * cy_network_interface_object_t
 Network interface object.
typedef struct cy_nw_ip_mac cy_nw_ip_mac_t
 MAC Address info.
typedef struct
cy_nw_arp_cache_entry 
cy_nw_arp_cache_entry_t
 ARP Cache Entry info.

Enumerations

enum  nw_ip_version { NW_IP_IPV4 = 4, NW_IP_IPV6 = 6, NW_IP_INVALID_IP = (-1) }
 

IP version.

More...
enum  cy_network_interface_type_t { CY_NW_INF_TYPE_WIFI = 0, CY_NW_INF_TYPE_ETH }
 

Network interface type.

More...

Functions

void cy_nw_ip_initialize_status_change_callback (cy_nw_ip_status_change_callback_t *info, cy_nw_ip_status_change_callback_func_t *cbf, void *arg)
 Initialize status change callback.
bool cy_nw_ip_get_ipv4_address (cy_nw_ip_interface_t iface, cy_nw_ip_address_t *addr)
 Retrieves the IPv4 address for an interface.
int cy_nw_str_to_ipv4 (const char *ip_str, cy_nw_ip_address_t *address)
 Convert IPv4 string to an IP address structure.
void cy_nw_ip_register_status_change_callback (cy_nw_ip_interface_t iface, cy_nw_ip_status_change_callback_t *info)
 Registers for callback function to be invoked during IP status change.
void cy_nw_ip_unregister_status_change_callback (cy_nw_ip_interface_t iface, cy_nw_ip_status_change_callback_t *info)
 Un-registers IP status change callback.
int cy_nw_host_arp_cache_clear (cy_nw_ip_interface_t iface)
 Clears the ARP cache for the interface NOTE: in LwIP, we need the netif (NetworkInterface) to do things, we can find using wifi interface.
int cy_nw_host_arp_cache_get_list (cy_nw_ip_interface_t iface, cy_nw_arp_cache_entry_t *list, uint32_t count, uint32_t *filled)
 Gets the ARP cache list for the interface.
int cy_nw_host_send_arp_request (cy_nw_ip_interface_t iface, const char *ip_string)
 Send ARP request NOTE: in LwIP, we need the netif (NetworkInterface) to do things, we can find using wifi interface.
uint32_t cy_nw_get_time (void)
 GET time in milliseconds.
bool cy_nw_aton (const char *char_ptr, cy_nw_ip_address_t *addr)
 GET IPv4 address in decimal notation.
bool cy_nw_aton_ipv6 (const char *char_ptr, cy_nw_ip_address_t *addr)
 GET IPv6 address in decimal notation.
bool cy_nw_ntoa (cy_nw_ip_address_t *addr, char *ip_str)
 GET IPv4 address in string format.
bool cy_nw_ntoa_ipv6 (cy_nw_ip_address_t *addr, char *ip_str)
 GET IPv6 address in string format.

Detailed Description

This is a collection of network helper functions which would be used by various Cypress Middleware libraries.

Definition in file cy_nw_helper.h.