Inheritance diagram for Cellular_driver_L3IP:

Public Types
typedef mbed::Callback< void(net_stack_mem_buf_t *buf)>	l3ip_link_input_cb_t
	Callback to be registered with L3IP interface and to be called for received packets. More...

typedef mbed::Callback< void(bool up)>	l3ip_link_state_change_cb_t
	Callback to be registered with L3IP interface and to be called for link status changes. More...

Public Member Functions
virtual uint32_t	get_mtu_size () const
	Return maximum transmission unit. More...

virtual uint32_t	get_align_preference () const
	Gets memory buffer alignment preference. More...

virtual void	get_ifname (char *name, uint8_t size) const
	Return interface name. More...

virtual bool	link_out (net_stack_mem_buf_t *buf)
	Sends the packet over the link. More...

virtual bool	power_up ()
	Initializes the hardware. More...

virtual void	power_down ()
	Deinitializes the hardware. More...

virtual void	set_link_input_cb (l3ip_link_input_cb_t input_cb)
	Sets a callback that needs to be called for packets received for that interface. More...

virtual void	set_link_state_cb (l3ip_link_state_change_cb_t state_cb)
	Sets a callback that needs to be called on link status changes for given interface. More...

virtual void	add_ipv4_multicast_group (const SocketAddress &address)
	Add device to an IP4 multicast group. More...

virtual void	add_ipv6_multicast_group (const SocketAddress &address)
	Add device to an IP6 multicast group. More...

virtual void	remove_ipv4_multicast_group (const SocketAddress &address)
	Remove device from an IPV4 multicast group. More...

virtual void	remove_ipv6_multicast_group (const SocketAddress &address)
	Remove device from an IPV6 multicast group. More...

virtual void	set_all_multicast (bool all)
	Request reception of all multicast packets. More...

virtual void	set_memory_manager (NetStackMemoryManager &mem_mngr)
	Sets memory manager that is used to handle memory buffers. More...

Static Public Member Functions
static L3IP &	get_default_instance ()
	Return the default on-board L3IP. More...

Detailed Description

Definition at line 24 of file cellular_driver_l3ip.h.

Member Typedef Documentation

typedef mbed::Callback<void (net_stack_mem_buf_t *buf)> l3ip_link_input_cb_t

inherited

Callback to be registered with L3IP interface and to be called for received packets.

Parameters

buf	Received data

Definition at line 47 of file L3IP.h.

typedef mbed::Callback<void (bool up)> l3ip_link_state_change_cb_t

inherited

Callback to be registered with L3IP interface and to be called for link status changes.

Parameters

up	Link status

Definition at line 55 of file L3IP.h.

Member Function Documentation

virtual void add_ipv4_multicast_group ( const SocketAddress & address )

virtual

Add device to an IP4 multicast group.

Parameters

address an IP4 multicast group address

Implements L3IP.

virtual void add_ipv6_multicast_group ( const SocketAddress & address )

virtual

Add device to an IP6 multicast group.

Parameters

address an IP6 multicast group address

Implements L3IP.

virtual uint32_t get_align_preference ( ) const

virtual

Gets memory buffer alignment preference.

Gets preferred memory buffer alignment of the cellular device.

Returns: Memory alignment requirement in bytes

Implements L3IP.

static L3IP& get_default_instance ( )

staticinherited

Return the default on-board L3IP.

Returns the default on-board L3IP - this will be target-specific, and may not be available on all targets.

virtual void get_ifname	(	char *	name,
		uint8_t	size
	)		const

virtual

Return interface name.

Parameters

name	Pointer to where the name should be written
size	Maximum number of characters to copy

Implements L3IP.

virtual uint32_t get_mtu_size ( ) const

virtual

Return maximum transmission unit.

Returns: MTU in bytes

Implements L3IP.

virtual bool link_out ( net_stack_mem_buf_t * buf )

virtual

Sends the packet over the link.

That cannot be called from an interrupt context.

Parameters

buf	Packet to be sent

Returns: True if the packet was sent, false otherwise

Implements L3IP.

virtual void power_down ( )

virtual

Deinitializes the hardware.

Implements L3IP.

virtual bool power_up ( )

virtual

Initializes the hardware.

Returns: True on success, False in case of an error.

Implements L3IP.

virtual void remove_ipv4_multicast_group ( const SocketAddress & address )

virtual

Remove device from an IPV4 multicast group.

Parameters

address An IPV4 multicast group address

Implements L3IP.

virtual void remove_ipv6_multicast_group ( const SocketAddress & address )

virtual

Remove device from an IPV6 multicast group.

Parameters

address An IPV6 multicast group address

Implements L3IP.

virtual void set_all_multicast ( bool all )

virtual

Request reception of all multicast packets.

Parameters

all	True to receive all multicasts False to receive only multicasts addressed to specified groups

Implements L3IP.

virtual void set_link_input_cb ( l3ip_link_input_cb_t input_cb )

virtual

Sets a callback that needs to be called for packets received for that interface.

Parameters

input_cb Function to be register as a callback

Implements L3IP.

virtual void set_link_state_cb ( l3ip_link_state_change_cb_t state_cb )

virtual

Sets a callback that needs to be called on link status changes for given interface.

Parameters

state_cb Function to be register as a callback

Implements L3IP.

virtual void set_memory_manager ( NetStackMemoryManager & mem_mngr )

virtual

Sets memory manager that is used to handle memory buffers.

Parameters

mem_mngr Pointer to memory manager

Implements L3IP.

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation

Important Information for this Arm website