Embedded Wireless Framework
Data Structures | Typedefs | Functions
Adapter information API

Functions to get information from the adapter. More...

Data Structures

struct  _ewf_adapter_api_info
 

Typedefs

typedef struct _ewf_adapter_api_info ewf_adapter_api_info
 

Functions

ewf_result ewf_adapter_info (ewf_adapter *adapter_ptr)
 Query and log the modem information. More...
 
ewf_result ewf_adapter_get_ipv4_address (ewf_adapter *adapter_ptr, uint32_t *address_ptr)
 Get the adapter's IPv4 address. More...
 
ewf_result ewf_adapter_get_ipv4_netmask (ewf_adapter *adapter_ptr, uint32_t *netmask_ptr)
 Get the adapter's IPv4 network mask. More...
 
ewf_result ewf_adapter_get_ipv4_gateway (ewf_adapter *adapter_ptr, uint32_t *gateway_ptr)
 Get the adapter's IPv4 gateway address. More...
 
ewf_result ewf_adapter_get_ipv4_dns (ewf_adapter *adapter_ptr, uint32_t *dns_ptr)
 Get the adapter's IPv4 primary DNS address. More...
 
ewf_result ewf_adapter_get_ipv6_address (ewf_adapter *adapter_ptr, uint8_t *address_buffer_ptr, uint32_t address_buffer_size, uint32_t *prefix_length_ptr)
 Get the adapter's IPv6 address. More...
 
ewf_result ewf_adapter_get_ipv6_next_hop (ewf_adapter *adapter_ptr, uint8_t *address_buffer_ptr, uint32_t address_buffer_size, uint32_t *prefix_length_ptr)
 Get the adapter's IPv6 next hop. More...
 
ewf_result ewf_adapter_get_ipv6_dns (ewf_adapter *adapter_ptr, uint8_t *address_buffer_ptr, uint32_t address_buffer_size, uint32_t *prefix_length_ptr)
 Get the adapter's IPv6 primary DNS address. More...
 

Detailed Description

Functions to get information from the adapter.

Function Documentation

◆ ewf_adapter_get_ipv4_address()

ewf_result ewf_adapter_get_ipv4_address ( ewf_adapter adapter_ptr,
uint32_t *  address_ptr 
)

Get the adapter's IPv4 address.

Parameters
[in]adapter_ptrA pointer to the adapter structure
address_ptr[in,out]a pointer to a variable that will receive the adapter IPv4 address
Returns
ewf_result success and error conditions

◆ ewf_adapter_get_ipv4_dns()

ewf_result ewf_adapter_get_ipv4_dns ( ewf_adapter adapter_ptr,
uint32_t *  dns_ptr 
)

Get the adapter's IPv4 primary DNS address.

Parameters
[in]adapter_ptrA pointer to the adapter structure
dns_ptr[in,out]a pointer to a variable that will receive the adapter primary IPv4 DNS address
Returns
ewf_result success and error conditions

◆ ewf_adapter_get_ipv4_gateway()

ewf_result ewf_adapter_get_ipv4_gateway ( ewf_adapter adapter_ptr,
uint32_t *  gateway_ptr 
)

Get the adapter's IPv4 gateway address.

Parameters
[in]adapter_ptrA pointer to the adapter structure
gateway_ptr[in,out]a pointer to a variable that will receive the adapter IPv4 gateway address
Returns
ewf_result success and error conditions

◆ ewf_adapter_get_ipv4_netmask()

ewf_result ewf_adapter_get_ipv4_netmask ( ewf_adapter adapter_ptr,
uint32_t *  netmask_ptr 
)

Get the adapter's IPv4 network mask.

Parameters
[in]adapter_ptrA pointer to the adapter structure
netmask_ptr[in,out]a pointer to a variable that will receive the adapter IPv4 netmask
Returns
ewf_result success and error conditions

◆ ewf_adapter_get_ipv6_address()

ewf_result ewf_adapter_get_ipv6_address ( ewf_adapter adapter_ptr,
uint8_t *  address_buffer_ptr,
uint32_t  address_buffer_size,
uint32_t *  prefix_length_ptr 
)

Get the adapter's IPv6 address.

Parameters
[in]adapter_ptrA pointer to the adapter structure
address_buffer_ptr[in,out]a pointer to a variable that will receive the adapter IPv6 address
Returns
ewf_result success and error conditions

◆ ewf_adapter_get_ipv6_dns()

ewf_result ewf_adapter_get_ipv6_dns ( ewf_adapter adapter_ptr,
uint8_t *  address_buffer_ptr,
uint32_t  address_buffer_size,
uint32_t *  prefix_length_ptr 
)

Get the adapter's IPv6 primary DNS address.

Parameters
[in]adapter_ptrA pointer to the adapter structure
address_buffer_ptr[in,out]a pointer to a variable that will receive the adapter primary IPv6 DNS address
Returns
ewf_result success and error conditions

◆ ewf_adapter_get_ipv6_next_hop()

ewf_result ewf_adapter_get_ipv6_next_hop ( ewf_adapter adapter_ptr,
uint8_t *  address_buffer_ptr,
uint32_t  address_buffer_size,
uint32_t *  prefix_length_ptr 
)

Get the adapter's IPv6 next hop.

Parameters
[in]adapter_ptrA pointer to the adapter structure
address_buffer_ptr[in,out]a pointer to a variable that will receive the next hop IPv6 address
Returns
ewf_result success and error conditions

◆ ewf_adapter_info()

ewf_result ewf_adapter_info ( ewf_adapter adapter_ptr)

Query and log the modem information.

Parameters
[in]adapter_ptrA pointer to the adapter structure
Returns
ewf_result success and error conditions