This interface should be used to abstract low level access to networking hardware All operations receive a void * hardware pointer which an ppp device provides when it is registered with a stack. More...

#include <ppp_service.h>

Inheritance diagram for ppp_service:

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

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

Public Member Functions
virtual uint32_t	get_mtu_size ()
	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, nsapi_ip_stack_t ip_stack)
	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 (ppp_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 (ppp_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	set_memory_manager (NetStackMemoryManager &mem_mngr)
	Sets memory manager that is used to handle memory buffers. More...

virtual void	set_stream (mbed::FileHandle *stream)
	Sets file stream used to communicate with modem. More...

virtual void	set_ip_stack (nsapi_ip_stack_t ip_stack)
	Sets IP protocol versions of IP stack. More...

virtual void	set_credentials (const char uname, const char password)
	Sets user name and password for PPP protocol. More...

virtual const nsapi_addr_t *	get_ip_address (nsapi_version_t version)
	Gets local IP address. More...

virtual const nsapi_addr_t *	get_netmask ()
	Get the local network mask. More...

virtual const nsapi_addr_t *	get_gateway ()
	Get the local gateway. More...

virtual const nsapi_addr_t *	get_dns_server (uint8_t index)
	Gets DNS server address. More...

virtual void	link_state (bool up)
	Link state indication from PPP. More...

virtual void	link_input (net_stack_mem_buf_t *buf)
	Received IP packet from PPP to stack. More...

virtual events::EventQueue *	event_queue_get ()
	Handle to PPP event queue. More...

virtual void	resource_lock ()
	Lock PPP resource. More...

virtual void	resource_unlock ()
	Unlock PPP resource. More...

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

Detailed Description

This interface should be used to abstract low level access to networking hardware All operations receive a void * hardware pointer which an ppp device provides when it is registered with a stack.

Definition at line 34 of file ppp_service.h.

Member Typedef Documentation

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

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

Parameters

buf	Received data

Definition at line 46 of file ppp_service.h.

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

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

Parameters

up	Link status

Definition at line 54 of file ppp_service.h.

Member Function Documentation

virtual events::EventQueue* event_queue_get ( )

virtual

Handle to PPP event queue.

Returns: Event queue

virtual uint32_t get_align_preference ( ) const

virtual

Gets memory buffer alignment preference.

Gets preferred memory buffer alignment of the ppp device.

Returns: Memory alignment requirement in bytes

Implements PPP.

static PPP& get_default_instance ( )

staticinherited

Return the default on-board PPP.

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

virtual const nsapi_addr_t* get_dns_server ( uint8_t index )

virtual

Gets DNS server address.

Parameters

index Server index

Implements PPP.

virtual const nsapi_addr_t* get_gateway ( )

virtual

Get the local gateway.

Returns: Local gateway or null if no network mask has been received.

Implements PPP.

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

virtual const nsapi_addr_t* get_ip_address ( nsapi_version_t version )

virtual

Gets local IP address.

Parameters

version IP address version

Returns: IP address

Implements PPP.

virtual uint32_t get_mtu_size ( )

virtual

Return maximum transmission unit.

Returns: MTU in bytes

Implements PPP.

virtual const nsapi_addr_t* get_netmask ( )

virtual

Get the local network mask.

Returns: Local network mask or null if no network mask has been received.

Implements PPP.

virtual void link_input ( net_stack_mem_buf_t * buf )

virtual

Received IP packet from PPP to stack.

Parameters

buf	Received packet

virtual bool link_out	(	net_stack_mem_buf_t *	buf,
		nsapi_ip_stack_t	ip_stack
	)

virtual

Sends the packet over the link.

That cannot be called from an interrupt context.

Parameters

buf	Packet to be send

Returns: True if the packet was send successfully, false otherwise

Implements PPP.

virtual void link_state ( bool up )

virtual

Link state indication from PPP.

Parameters

up	Link status

virtual void power_down ( )

virtual

Deinitializes the hardware.

Implements PPP.

virtual bool power_up ( )

virtual

Initializes the hardware.

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

Implements PPP.

virtual void resource_lock ( )

virtual

Lock PPP resource.

virtual void resource_unlock ( )

virtual

Unlock PPP resource.

virtual void set_credentials	(	const char *	uname,
		const char *	password
	)

virtual

Sets user name and password for PPP protocol.

Parameters

uname	User name
password	Password

Implements PPP.

virtual void set_ip_stack ( nsapi_ip_stack_t ip_stack )

virtual

Sets IP protocol versions of IP stack.

Parameters

ip_stack IP protocol version

Implements PPP.

virtual void set_link_input_cb ( ppp_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 PPP.

virtual void set_link_state_cb ( ppp_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 PPP.

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

virtual void set_stream ( mbed::FileHandle * stream )

virtual

Sets file stream used to communicate with modem.

Parameters

stream Pointer to file handle

Implements PPP.

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation

Important Information for this Arm website