Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
LWIP::Interface Class Referencefinal
Inheritance diagram for LWIP::Interface:
OnboardNetworkStack::Interface

Public Member Functions

nsapi_error_t set_ip_address (const char *ip, const char *netmask, const char *gw, uint8_t ipv6_flag=0) override
 Set IP address to LWIP stack. More...
 
nsapi_error_t bringup (bool dhcp, const char *ip, const char *netmask, const char *gw, nsapi_ip_stack_t stack=DEFAULT_STACK, bool blocking=true) override
 Connect the interface to the network. More...
 
nsapi_error_t bringdown () override
 Disconnect interface from the network. More...
 
void attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb) override
 Register callback for status reporting. More...
 
nsapi_connection_status_t get_connection_status () const override
 Get the connection status. More...
 
char * get_interface_name (char *buf) override
 Return netif interface name. More...
 
char * get_mac_address (char *buf, nsapi_size_t buflen) override
 Return MAC address of the network interface. More...
 
nsapi_error_t get_ip_address (SocketAddress *address) override
 Get the local IP address. More...
 
nsapi_error_t get_ipv6_link_local_address (SocketAddress *address) override
 Get the IPv6 link local address in SocketAddress representation. More...
 
nsapi_error_t get_netmask (SocketAddress *address) override
 Copies netmask of the network interface to user supplied buffer. More...
 
nsapi_error_t get_gateway (SocketAddress *address) override
 Copies gateway address of the network interface to user supplied buffer. More...
 

Detailed Description

Definition at line 46 of file LWIPStack.h.

Member Function Documentation

void attach ( mbed::Callback< void(nsapi_event_t, intptr_t)>  status_cb)
overridevirtual

Register callback for status reporting.

The specified status callback function will be called on status changes on the network. The parameters on the callback are the event type and event-type dependent reason parameter.

Parameters
status_cbThe callback for status changes

Implements OnboardNetworkStack::Interface.

nsapi_error_t bringdown ( )
overridevirtual

Disconnect interface from the network.

After this call the network interface is inactive, to use it again user needs to call mbed_ipstack_bringup again.

Returns
NSAPI_ERROR_OK on success, or error code

Implements OnboardNetworkStack::Interface.

nsapi_error_t bringup ( bool  dhcp,
const char *  ip,
const char *  netmask,
const char *  gw,
nsapi_ip_stack_t  stack = DEFAULT_STACK,
bool  blocking = true 
)
overridevirtual

Connect the interface to the network.

Sets up a connection on specified network interface, using DHCP or provided network details. If the dhcp is set to true all the remaining parameters are ignored.

Parameters
dhcptrue if the network details should be acquired using DHCP
ipIP address to be used for the interface as "W:X:Y:Z" or NULL
netmaskNet mask to be used for the interface as "W:X:Y:Z" or NULL
gwGateway address to be used for the interface as "W:X:Y:Z" or NULL
stackAllow manual selection of IPv4 and/or IPv6.
blockingSpecify whether bringup blocks for connection completion.
Returns
NSAPI_ERROR_OK on success, or error code

Implements OnboardNetworkStack::Interface.

nsapi_connection_status_t get_connection_status ( ) const
overridevirtual

Get the connection status.

Returns
The connection status according to ConnectionStatusType

Implements OnboardNetworkStack::Interface.

nsapi_error_t get_gateway ( SocketAddress address)
overridevirtual

Copies gateway address of the network interface to user supplied buffer.

Parameters
bufbuffer to which gateway address will be copied as "W:X:Y:Z"
buflensize of supplied buffer
Returns
Pointer to a buffer, or NULL if the buffer is too small

Implements OnboardNetworkStack::Interface.

char* get_interface_name ( char *  buf)
overridevirtual

Return netif interface name.

Returns
netif name eg "en0"

Reimplemented from OnboardNetworkStack::Interface.

nsapi_error_t get_ip_address ( SocketAddress address)
overridevirtual

Get the local IP address.

Parameters
addressSocketAddress representation of the local IP address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

Implements OnboardNetworkStack::Interface.

nsapi_error_t get_ipv6_link_local_address ( SocketAddress address)
overridevirtual

Get the IPv6 link local address in SocketAddress representation.

SocketAddress representation of the link local IPv6 address

Returns
NSAPI_ERROR_OK on success, or error code

Reimplemented from OnboardNetworkStack::Interface.

char* get_mac_address ( char *  buf,
nsapi_size_t  buflen 
)
overridevirtual

Return MAC address of the network interface.

Returns
MAC address as "V:W:X:Y:Z"

Implements OnboardNetworkStack::Interface.

nsapi_error_t get_netmask ( SocketAddress address)
overridevirtual

Copies netmask of the network interface to user supplied buffer.

Parameters
bufbuffer to which netmask will be copied as "W:X:Y:Z"
buflensize of supplied buffer
Returns
Pointer to a buffer, or NULL if the buffer is too small

Implements OnboardNetworkStack::Interface.

nsapi_error_t set_ip_address ( const char *  ip,
const char *  netmask,
const char *  gw,
uint8_t  ipv6_flag = 0 
)
overridevirtual

Set IP address to LWIP stack.

This function can set both IPv4 or IPv6 address to LWIP stack.

bringup() can only take one IP address and in dual stack case another IP address can be set using this function.

IPv4 or IPv6 address should be in format of https://tools.ietf.org/html/draft-main-ipaddr-text-rep-00.

Parameters
ipIP address to be used for the interface as IPv4 or IPv6 address string. This parameter should not be NULL.
netmaskNet mask to be used for the interface as IPv4 address string or NULL. NULL value will set this value to 255.255.255.255. This parameter will be ignored for IPv6 ip argument.
gwGateway address to be used for the interface as IPv4 address string or NULL NULL value will set this value to 0.0.0.0 This parameter will be ignored for IPv6 ip argument.
ipv6_flagProvide this flag for IPv6 state flag override. For example, you can set IP6_ADDR_PREFERRED. Default value is IP6_ADDR_VALID. For IPv4, this value will be ignored.
Returns
NSAPI_ERROR_OK on success, or error code

Reimplemented from OnboardNetworkStack::Interface.

Field Documentation

void* hw

alternative implementation pointer - used for PPP

Definition at line 222 of file LWIPStack.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.