Portable PPP engine: LCP, PAP client and IPCP over an Arduino Stream. More...

#include <PPPEngine.h>

Inheritance diagram for PPPEngine:

Public Member Functions
virtual	~PPPEngine ()=default

bool	beginIPv4 ()
	Streaming API for chained buffers (e.g. lwIP pbuf)

ip4_t	dns1 () const
	First DNS server received from the peer.

ip4_t	dns2 () const
	Second DNS server received from the peer.

bool	endIPv4 ()
	Sends the packet started with beginIPv4()

uint32_t	fcsErrors () const
	Number of received frames with a wrong FCS.

void	input (const uint8_t *data, size_t len)

bool	isStarted () const
	true after start() until stop()

bool	isUp () const
	true when IPCP is open and IPv4 packets can be exchanged

ip4_t	localIP () const
	Our IP address (0 if not negotiated yet)

uint16_t	mtu () const
	MTU we may use for sending (peer MRU)

ip4_t	peerIP () const
	IP address of the peer.

PPPPhase	phase () const
	Current link phase.

void	process ()
	Reads available input and runs the timers: call frequently.

void	processTimers (uint32_t now)
	Runs the retransmission and keep-alive timers.

bool	sendIPv4 (const uint8_t *data, size_t len)
	Sends a complete IPv4 packet.

void	setCredentials (const char user, const char password)
	PAP credentials (used only if the peer requires authentication)

void	setEchoInterval (uint32_t ms, uint8_t maxFailures=3)
	LCP echo keep-alive: 0 disables it.

void	setLocalIP (ip4_t ip)
	Optional static address configuration. 0 = negotiate with the peer.

void	setLogger (Print *log)
	Debug output (nullptr to disable)

void	setOfferedDNS (ip4_t dns1, ip4_t dns2=0)
	DNS servers to offer the peer if it asks for them (server role)

void	setPassive (bool passive)
	Passive: do not send LCP requests before the peer starts negotiating.

void	setPeerIP (ip4_t ip)
	Address to assign to the peer if it requests one (server role)

void	setRequestDNS (bool flag)
	Request DNS servers from the peer (default true)

void	start (Stream &io)
	Starts the PPP negotiation on the indicated stream.

const PPPStats &	stats () const
	Frame and packet counters.

void	stop ()
	Closes the link gracefully (sends LCP Terminate-Request)

void	writeIPv4 (const uint8_t *data, size_t len)
	Adds data to the packet started with beginIPv4()

Protected Member Functions
void	logf (const char *fmt,...)

virtual void	onIPv4Packet (const uint8_t *data, size_t len)
	Called for each received IPv4 packet.

virtual void	onLinkDown ()
	Called when the IP link goes down.

virtual void	onLinkUp ()
	Called when IPCP is opened: addresses are available.

virtual void	onPhase (PPPPhase phase)
	Called on phase changes.

Static Protected Member Functions
static const char *	ipStr (ip4_t ip, char *buf)

Detailed Description

Portable PPP engine: LCP, PAP client and IPCP over an Arduino Stream.

The engine has no IP stack: subclasses receive IPv4 packets in onIPv4Packet() and are notified about the link state with onLinkUp() and onLinkDown(). Call process() regularly to handle input and timers.

Constructor & Destructor Documentation

◆ ~PPPEngine()

virtual ~PPPEngine ( )

virtualdefault

Member Function Documentation

◆ beginIPv4()

bool beginIPv4 ( )

inline

Streaming API for chained buffers (e.g. lwIP pbuf)

◆ dns1()

ip4_t dns1 ( ) const

inline

First DNS server received from the peer.

◆ dns2()

ip4_t dns2 ( ) const

inline

Second DNS server received from the peer.

◆ endIPv4()

bool endIPv4 ( )

inline

Sends the packet started with beginIPv4()

◆ fcsErrors()

uint32_t fcsErrors ( ) const

inline

Number of received frames with a wrong FCS.

◆ input()

void input	(	const uint8_t *	data,
		size_t	len
	)

inline

Feeds raw bytes (alternative to process() when you read the stream yourself)

◆ ipStr()

static const char * ipStr	(	ip4_t	ip,
		char *	buf
	)

inlinestaticprotected

◆ isStarted()

bool isStarted ( ) const

inline

true after start() until stop()

◆ isUp()

bool isUp ( ) const

inline

true when IPCP is open and IPv4 packets can be exchanged

◆ localIP()

ip4_t localIP ( ) const

inline

Our IP address (0 if not negotiated yet)

◆ logf()

void logf	(	const char *	fmt,
			...
	)

inlineprotected

◆ mtu()

uint16_t mtu ( ) const

inline

MTU we may use for sending (peer MRU)

◆ onIPv4Packet()

virtual void onIPv4Packet	(	const uint8_t *	data,
		size_t	len
	)

inlineprotectedvirtual

Called for each received IPv4 packet.

Reimplemented in TinyPPP_Generic, and TinyPPP_RP2040.

◆ onLinkDown()

virtual void onLinkDown ( )

inlineprotectedvirtual

Called when the IP link goes down.

Reimplemented in TinyPPP_Generic, and TinyPPP_RP2040.

◆ onLinkUp()

virtual void onLinkUp ( )

inlineprotectedvirtual

Called when IPCP is opened: addresses are available.

Reimplemented in TinyPPP_Generic, and TinyPPP_RP2040.

◆ onPhase()

virtual void onPhase ( PPPPhase phase )

inlineprotectedvirtual

Called on phase changes.

◆ peerIP()

ip4_t peerIP ( ) const

inline

IP address of the peer.

◆ phase()

PPPPhase phase ( ) const

inline

Current link phase.

◆ process()

void process ( )

inline

Reads available input and runs the timers: call frequently.

◆ processTimers()

void processTimers ( uint32_t now )

inline

Runs the retransmission and keep-alive timers.

◆ sendIPv4()

bool sendIPv4	(	const uint8_t *	data,
		size_t	len
	)

inline

Sends a complete IPv4 packet.

◆ setCredentials()

void setCredentials	(	const char *	user,
		const char *	password
	)

inline

PAP credentials (used only if the peer requires authentication)

◆ setEchoInterval()

void setEchoInterval	(	uint32_t	ms,
		uint8_t	maxFailures = `3`
	)

inline

LCP echo keep-alive: 0 disables it.

◆ setLocalIP()

void setLocalIP ( ip4_t ip )

inline

Optional static address configuration. 0 = negotiate with the peer.

◆ setLogger()

void setLogger ( Print * log )

inline

Debug output (nullptr to disable)

◆ setOfferedDNS()

void setOfferedDNS	(	ip4_t	dns1,
		ip4_t	dns2 = `0`
	)

inline

DNS servers to offer the peer if it asks for them (server role)

◆ setPassive()

void setPassive ( bool passive )

inline

Passive: do not send LCP requests before the peer starts negotiating.

◆ setPeerIP()

void setPeerIP ( ip4_t ip )

inline

Address to assign to the peer if it requests one (server role)

◆ setRequestDNS()

void setRequestDNS ( bool flag )

inline

Request DNS servers from the peer (default true)

◆ start()

void start ( Stream & io )

inline

Starts the PPP negotiation on the indicated stream.

◆ stats()

const PPPStats & stats ( ) const

inline

Frame and packet counters.

◆ stop()

void stop ( )

inline

Closes the link gracefully (sends LCP Terminate-Request)

◆ writeIPv4()

void writeIPv4	(	const uint8_t *	data,
		size_t	len
	)

inline

Adds data to the packet started with beginIPv4()

The documentation for this class was generated from the following file:

src/tinyppp/PPPEngine.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~PPPEngine()

Member Function Documentation

◆ beginIPv4()

◆ dns1()

◆ dns2()

◆ endIPv4()

◆ fcsErrors()

◆ input()

◆ ipStr()

◆ isStarted()

◆ isUp()

◆ localIP()

◆ logf()

◆ mtu()

◆ onIPv4Packet()

◆ onLinkDown()

◆ onLinkUp()

◆ onPhase()

◆ peerIP()

◆ phase()

◆ process()

◆ processTimers()

◆ sendIPv4()

◆ setCredentials()

◆ setEchoInterval()

◆ setLocalIP()

◆ setLogger()

◆ setOfferedDNS()

◆ setPassive()

◆ setPeerIP()

◆ setRequestDNS()

◆ start()

◆ stats()

◆ stop()

◆ writeIPv4()