Inheritance diagram for EmacTestNetworkStack::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)
	Connect the interface to the network. More...

virtual nsapi_error_t	bringdown ()
	Disconnect interface from the network. 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...

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

virtual nsapi_error_t	get_ip_address (SocketAddress *address)
	Copies IP address of the network interface to user supplied buffer. More...

virtual nsapi_error_t	get_netmask (SocketAddress *address)
	Copies netmask of the network interface to user supplied buffer. More...

virtual nsapi_error_t	get_gateway (SocketAddress *address)
	Copies gateway address of the network interface to user supplied buffer. More...

virtual nsapi_error_t	set_ip_address (const char ip, const char netmask, const char *gw, uint8_t ipv6_flag)
	Set IP address. 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...

Detailed Description

Definition at line 35 of file emac_TestNetworkStack.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 ( )

virtual

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.

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

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

Implements OnboardNetworkStack::Interface.

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

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

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 LWIP::Interface, Nanostack::MeshInterface, Nanostack::PPPInterface, and Nanostack::EthernetInterface.

Definition at line 125 of file OnboardNetworkStack.h.

virtual nsapi_error_t get_ip_address ( SocketAddress * address )

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

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

Implements OnboardNetworkStack::Interface.

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

Reimplemented in LWIP::Interface.

Definition at line 140 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

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

Implements OnboardNetworkStack::Interface.

virtual nsapi_error_t set_ip_address	(	const char *	ip,
		const char *	netmask,
		const char *	gw,
		uint8_t	ipv6_flag
	)

virtualinherited

Set IP address.

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

Must be called before bringup().

Parameters

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
ipv6_flag	Provide this flag for IPv6 state flag override. For example, you can set IP6_ADDR_PREFERRED. For IPv4, this value will be ignored.

Returns: NSAPI_ERROR_OK on success, or error code

Reimplemented in LWIP::Interface.

Definition at line 69 of file OnboardNetworkStack.h.

Public Member Functions

Detailed Description

Member Function Documentation

Important Information for this Arm website