Inheritance diagram for Nanostack::Interface:

Public Member Functions
virtual nsapi_error_t	get_ip_address (SocketAddress *address)
	Get the local IP address. More...

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

virtual nsapi_error_t	get_netmask (SocketAddress *address)

virtual nsapi_error_t	get_gateway (SocketAddress *address)

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 nsapi_error_t	get_ipv6_link_local_address (SocketAddress *address)
	Get the IPv6 link local address. More...

virtual nsapi_error_t	get_ip_address_if (SocketAddress address, const char interface_name)
	Get the local IP address on interface name. More...

Detailed Description

Definition at line 26 of file MeshInterfaceNanostack.h.

Member Function Documentation

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

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

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

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

virtual

Get the connection status.

Returns: The connection status according to ConnectionStatusType

Implements OnboardNetworkStack::Interface.

virtual nsapi_error_t get_gateway ( SocketAddress * address )

virtual

Implements OnboardNetworkStack::Interface.

virtual char* get_interface_name ( char * buf )

virtualinherited

Returns interface name.

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

Reimplemented in Nanostack::MeshInterface, Nanostack::PPPInterface, and Nanostack::EthernetInterface.

Definition at line 101 of file OnboardNetworkStack.h.

virtual nsapi_error_t get_ip_address ( SocketAddress * address )

virtual

Get the local IP address.

Parameters

address SocketAddress representation of the local IP address

Return values

NSAPI_ERROR_OK	on success
NSAPI_ERROR_UNSUPPORTED	if this feature is not supported
NSAPI_ERROR_PARAMETER	if the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESS	if the address cannot be obtained from stack

Implements OnboardNetworkStack::Interface.

virtual nsapi_error_t get_ip_address_if	(	SocketAddress *	address,
		const char *	interface_name
	)

virtualinherited

Get the local IP address on interface name.

Parameters

address	SocketAddress representation of the link local IPv6 address
interface_name	Network interface_name

Return values

NSAPI_ERROR_OK	on success
NSAPI_ERROR_UNSUPPORTED	if this feature is not supported
NSAPI_ERROR_PARAMETER	if the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESS	if the address cannot be obtained from stack

Definition at line 125 of file OnboardNetworkStack.h.

virtual nsapi_error_t get_ipv6_link_local_address ( SocketAddress * address )

virtualinherited

Get the IPv6 link local address.

Parameters

address SocketAddress representation of the link local IPv6 address

Return values

NSAPI_ERROR_OK	on success
NSAPI_ERROR_UNSUPPORTED	if this feature is not supported
NSAPI_ERROR_PARAMETER	if the provided pointer is invalid

Definition at line 119 of file OnboardNetworkStack.h.

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

virtual

Return MAC address of the network interface.

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

Implements OnboardNetworkStack::Interface.

virtual nsapi_error_t get_netmask ( SocketAddress * address )

virtual

Implements OnboardNetworkStack::Interface.

void network_handler ( mesh_connection_status_t status )

Callback from C-layer.

Parameters

status state of the network

Public Member Functions

Detailed Description

Member Function Documentation

Important Information for this Arm website