Representation of a stack's view of an interface. More...

#include <OnboardNetworkStack.h>

Inheritance diagram for OnboardNetworkStack::Interface:

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
	Connect the interface to the network. More...

virtual nsapi_error_t	bringdown ()=0
	Disconnect interface from the network. More...

virtual void	attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)=0
	Register callback for status reporting. More...

virtual nsapi_connection_status_t	get_connection_status () const =0
	Get the connection status. More...

virtual char *	get_interface_name (char *buf)
	Returns interface name. More...

virtual char *	get_mac_address (char *buf, nsapi_size_t buflen)=0
	Return MAC address of the network interface. More...

virtual char *	get_ip_address (char *buf, nsapi_size_t buflen)=0
	Copies IP address of the network interface to user supplied buffer. 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...

virtual char *	get_netmask (char *buf, nsapi_size_t buflen)=0
	Copies netmask of the network interface to user supplied buffer. More...

virtual char *	get_gateway (char *buf, nsapi_size_t buflen)=0
	Copies gateway address of the network interface to user supplied buffer. More...

Detailed Description

Representation of a stack's view of an interface.

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

Definition at line 49 of file OnboardNetworkStack.h.

Member Function Documentation

virtual void 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_cb The callback for status changes

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

virtual nsapi_error_t 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 EmacTestNetworkStack::Interface, Nanostack::EthernetInterface, and Nanostack::PPPInterface.

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 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

dhcp	true if the network details should be acquired using DHCP
ip	IP address to be used for the interface as "W:X:Y:Z" or NULL
netmask	Net mask to be used for the interface as "W:X:Y:Z" or NULL
gw	Gateway address to be used for the interface as "W:X:Y:Z" or NULL
stack	Allow manual selection of IPv4 and/or IPv6.
blocking	Specify whether bringup blocks for connection completion.

Returns: NSAPI_ERROR_OK on success, or error code

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

virtual nsapi_connection_status_t get_connection_status ( ) const

pure virtual

Get the connection status.

Returns: The connection status according to ConnectionStatusType

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

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

pure virtual

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

Parameters

buf	buffer to which gateway address will be copied as "W:X:Y:Z"
buflen	size of supplied buffer

Returns: Pointer to a buffer, or NULL if the buffer is too small

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

virtual char* get_interface_name ( char * buf )

virtual

Returns interface name.

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

Definition at line 101 of file OnboardNetworkStack.h.

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

pure virtual

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

Parameters

buf	buffer to which IP address will be copied as "W:X:Y:Z"
buflen	size of supplied buffer
interface_name	Network interface name

Returns: Pointer to a buffer, or NULL if the buffer is too small

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

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

virtual

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

Parameters

buf	buffer to which IP address will be copied as "W:X:Y:Z"
buflen	size of supplied buffer
interface_name	Network interface name

Returns: Pointer to a buffer, or NULL if the buffer is too small

Definition at line 129 of file OnboardNetworkStack.h.

virtual char* 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 EmacTestNetworkStack::Interface, and Nanostack::Interface.

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

pure virtual

Copies netmask of the network interface to user supplied buffer.

Parameters

buf	buffer to which netmask will be copied as "W:X:Y:Z"
buflen	size of supplied buffer

Returns: Pointer to a buffer, or NULL if the buffer is too small

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

Public Member Functions

Detailed Description

Member Function Documentation

Important Information for this Arm website