UDP Class Reference

#include <Udp.h>

Inheritance diagram for UDP:

Public Member Functions
virtual int	available ()=0
virtual uint8_t	begin (uint16_t)=0
virtual uint8_t	beginMulticast (IPAddress, uint16_t)
virtual int	beginPacket (IPAddress ip, uint16_t port)=0
virtual int	beginPacket (const char *host, uint16_t port)=0
virtual int	endPacket ()=0
virtual void	flush ()=0
virtual int	parsePacket ()=0
virtual int	peek ()=0
virtual int	read ()=0
virtual int	read (unsigned char *buffer, size_t len)=0
virtual int	read (char *buffer, size_t len)=0
virtual IPAddress	remoteIP ()=0
virtual uint16_t	remotePort ()=0
virtual void	stop ()=0
virtual size_t	write (uint8_t)=0
virtual size_t	write (const uint8_t *buffer, size_t size)=0
Public Member Functions inherited from Stream
bool	find (char *target)
bool	find (uint8_t *target)
bool	find (char *target, size_t length)
bool	find (uint8_t *target, size_t length)
bool	find (char target)
bool	findUntil (char *target, char *terminator)
bool	findUntil (uint8_t *target, char *terminator)
bool	findUntil (char *target, size_t targetLen, char *terminate, size_t termLen)
bool	findUntil (uint8_t *target, size_t targetLen, char *terminate, size_t termLen)
unsigned long	getTimeout (void)
float	parseFloat (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
long	parseInt (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)
size_t	readBytes (char *buffer, size_t length)
size_t	readBytes (uint8_t *buffer, size_t length)
size_t	readBytesUntil (char terminator, char *buffer, size_t length)
size_t	readBytesUntil (char terminator, uint8_t *buffer, size_t length)
String	readString ()
String	readStringUntil (char terminator)
void	setTimeout (unsigned long timeout)
	Stream ()
Public Member Functions inherited from Print
virtual int	availableForWrite ()
void	clearWriteError ()
int	getWriteError ()
	Print ()
size_t	print (const __FlashStringHelper *)
size_t	print (const String &)
size_t	print (const char[])
size_t	print (char)
size_t	print (unsigned char, int=DEC)
size_t	print (int, int=DEC)
size_t	print (unsigned int, int=DEC)
size_t	print (long, int=DEC)
size_t	print (unsigned long, int=DEC)
size_t	print (double, int=2)
size_t	print (const Printable &)
size_t	println (const __FlashStringHelper *)
size_t	println (const String &s)
size_t	println (const char[])
size_t	println (char)
size_t	println (unsigned char, int=DEC)
size_t	println (int, int=DEC)
size_t	println (unsigned int, int=DEC)
size_t	println (long, int=DEC)
size_t	println (unsigned long, int=DEC)
size_t	println (double, int=2)
size_t	println (const Printable &)
size_t	println (void)
size_t	write (const char *str)
size_t	write (const char *buffer, size_t size)

Protected Member Functions
uint8_t *	rawIPAddress (IPAddress &addr)
Protected Member Functions inherited from Stream
int	findMulti (struct MultiTarget *targets, int tCount)
float	parseFloat (char ignore)
long	parseInt (char ignore)
int	peekNextDigit (LookaheadMode lookahead, bool detectDecimal)
int	timedPeek ()
int	timedRead ()
Protected Member Functions inherited from Print
void	setWriteError (int err=1)

Additional Inherited Members
Protected Attributes inherited from Stream
unsigned long	_startMillis
unsigned long	_timeout

Detailed Description

Definition at line 41 of file Udp.h.

Member Function Documentation

virtual int UDP::available ( )

pure virtual

Implements Stream.

virtual uint8_t UDP::begin ( uint16_t  )

pure virtual

virtual uint8_t UDP::beginMulticast ( IPAddress  , uint16_t    )

inlinevirtual

Definition at line 45 of file Udp.h.

virtual int UDP::beginPacket ( IPAddress  ip, uint16_t  port  )

pure virtual

virtual int UDP::beginPacket ( const char *  host, uint16_t  port  )

pure virtual

virtual int UDP::endPacket ( )

pure virtual

virtual void UDP::flush ( )

pure virtual

Reimplemented from Print.

virtual int UDP::parsePacket ( )

pure virtual

virtual int UDP::peek ( )

pure virtual

Implements Stream.

uint8_t* UDP::rawIPAddress ( IPAddress &  addr )

inlineprotected

Definition at line 86 of file Udp.h.

virtual int UDP::read ( )

pure virtual

Implements Stream.

virtual int UDP::read ( unsigned char *  buffer, size_t  len  )

pure virtual

virtual int UDP::read ( char *  buffer, size_t  len  )

pure virtual

virtual IPAddress UDP::remoteIP ( )

pure virtual

virtual uint16_t UDP::remotePort ( )

pure virtual

virtual void UDP::stop ( )

pure virtual

virtual size_t UDP::write ( uint8_t  )

pure virtual

Implements Print.

virtual size_t UDP::write ( const uint8_t *  buffer, size_t  size  )

pure virtual

Reimplemented from Print.

---

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

• Udp.h