Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
Nanostack::MeshInterface Class Referenceabstract
Inheritance diagram for Nanostack::MeshInterface:
Nanostack::Interface OnboardNetworkStack::Interface NonCopyable< Nanostack::Interface >

Public Member Functions

virtual char * get_ip_address (char *buf, nsapi_size_t buflen)
 Copies IP address of the network interface to user supplied buffer. More...
 
virtual char * get_mac_address (char *buf, nsapi_size_t buflen)
 Return MAC address of the network interface. More...
 
virtual char * get_netmask (char *buf, nsapi_size_t buflen)
 Copies netmask of the network interface to user supplied buffer. More...
 
virtual char * get_gateway (char *buf, nsapi_size_t buflen)
 Copies gateway address of the network interface to user supplied buffer. More...
 
virtual void attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
 Register callback for status reporting. More...
 
virtual nsapi_connection_status_t get_connection_status () const
 Get the connection status. More...
 
void network_handler (mesh_connection_status_t status)
 Callback from C-layer. More...
 
virtual 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)=0
 Connect the interface to the network. More...
 
virtual nsapi_error_t bringdown ()=0
 Disconnect interface from the network. More...
 
virtual char * get_interface_name (char *buf)
 Returns interface name. More...
 
virtual char * get_ip_address_if (char *buf, nsapi_size_t buflen, const char *interface_name)
 Copies IP address of the network interface to user supplied buffer. More...
 

Detailed Description

Definition at line 74 of file MeshInterfaceNanostack.h.

Member Function Documentation

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

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.

virtual nsapi_error_t bringdown ( )
pure virtualinherited

Disconnect interface from the network.

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

Returns
NSAPI_ERROR_OK on success, or error code

Implemented in EmacTestNetworkStack::Interface, and Nanostack::EthernetInterface.

virtual 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 
)
pure virtualinherited

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

Implemented in EmacTestNetworkStack::Interface, and Nanostack::EthernetInterface.

virtual nsapi_connection_status_t get_connection_status ( ) const
virtualinherited

Get the connection status.

Returns
The connection status according to ConnectionStatusType

Implements OnboardNetworkStack::Interface.

virtual char* get_gateway ( char *  buf,
nsapi_size_t  buflen 
)
virtualinherited

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.

virtual char* get_interface_name ( char *  buf)
virtualinherited

Returns interface name.

Returns
string containing name of network interface for example "en0"

Definition at line 100 of file OnboardNetworkStack.h.

virtual char* get_ip_address ( char *  buf,
nsapi_size_t  buflen 
)
virtualinherited

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

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

Implements OnboardNetworkStack::Interface.

virtual char* get_ip_address_if ( char *  buf,
nsapi_size_t  buflen,
const char *  interface_name 
)
virtualinherited

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

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

Definition at line 128 of file OnboardNetworkStack.h.

virtual char* get_mac_address ( char *  buf,
nsapi_size_t  buflen 
)
virtualinherited

Return MAC address of the network interface.

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

Implements OnboardNetworkStack::Interface.

virtual char* get_netmask ( char *  buf,
nsapi_size_t  buflen 
)
virtualinherited

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.

void network_handler ( mesh_connection_status_t  status)
inherited

Callback from C-layer.

Parameters
statusstate of the network
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.