Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
OnboardNetworkStack::Interface Class Referenceabstract

#include <OnboardNetworkStack.h>

Inheritance diagram for OnboardNetworkStack::Interface:
Nanostack::Interface Nanostack::EthernetInterface Nanostack::MeshInterface NanostackEMACInterface NanostackRfInterface Nanostack::LoWPANNDInterface Nanostack::ThreadInterface

Public Member Functions

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
 
virtual nsapi_error_t bringdown ()=0
 
virtual void attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)=0
 
virtual nsapi_connection_status_t get_connection_status () const =0
 
virtual char * get_mac_address (char *buf, nsapi_size_t buflen)=0
 
virtual char * get_ip_address (char *buf, nsapi_size_t buflen)=0
 
virtual char * get_netmask (char *buf, nsapi_size_t buflen)=0
 
virtual char * get_gateway (char *buf, nsapi_size_t buflen)=0
 

Detailed Description

Representation of a stack's view of an interface.

Provides facilities required by a driver to implement the application NetworkInterface API.

Member Function Documentation

virtual void OnboardNetworkStack::Interface::attach ( mbed::Callback< void(nsapi_event_t, intptr_t)>  status_cb)
pure virtual

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

Implemented in Nanostack::Interface.

virtual nsapi_error_t OnboardNetworkStack::Interface::bringdown ( )
pure virtual

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 Nanostack::EthernetInterface, Nanostack::LoWPANNDInterface, and Nanostack::ThreadInterface.

virtual nsapi_error_t OnboardNetworkStack::Interface::bringup ( bool  dhcp,
const char *  ip,
const char *  netmask,
const char *  gw,
nsapi_ip_stack_t  stack = DEFAULT_STACK,
bool  blocking = true 
)
pure virtual

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 Nanostack::EthernetInterface, Nanostack::LoWPANNDInterface, and Nanostack::ThreadInterface.

virtual nsapi_connection_status_t OnboardNetworkStack::Interface::get_connection_status ( ) const
pure virtual

Get the connection status

Returns
The connection status according to ConnectionStatusType

Implemented in Nanostack::Interface.

virtual char* OnboardNetworkStack::Interface::get_gateway ( char *  buf,
nsapi_size_t  buflen 
)
pure virtual

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

Implemented in Nanostack::Interface, and Nanostack::LoWPANNDInterface.

virtual char* OnboardNetworkStack::Interface::get_ip_address ( char *  buf,
nsapi_size_t  buflen 
)
pure virtual

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
Returns
Pointer to a buffer, or NULL if the buffer is too small

Implemented in Nanostack::Interface.

virtual char* OnboardNetworkStack::Interface::get_mac_address ( char *  buf,
nsapi_size_t  buflen 
)
pure virtual

Return MAC address of the network interface

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

Implemented in Nanostack::Interface.

virtual char* OnboardNetworkStack::Interface::get_netmask ( char *  buf,
nsapi_size_t  buflen 
)
pure virtual

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

Implemented in Nanostack::Interface.


The documentation for this class was generated from the following file:
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.