User Manual

Parameters: None

Returns: The IPAddress (https://adafru.it/lGd) of the remote UDP server/connection.

uint16_t remotePort (void)

Returns the port for the remote UDP server.

Parameters: None

Returns: The port of the remote UDP server/connection.

Stream API

The following functions are based on the Stream (https://adafru.it/lGe) class that Arduino

EthernetUDP (https://adafru.it/lGA) implements.

int read (void)

Reads the first available byte in the UDP buffer.

Parameters: None

Returns: The first character available in the UDP buffer, or 'EOF' if no data is available.

int read (unsigned char* buffer, size_t len)

int read (char* buffer, size_t len)

These two identical functions (other than the type used for the 'buffer') will read up to 'len' bytes from the UDP

response data, copying them into the buffer provided in the first argument of this function.

Parameters:

buffer: A pointer to the buffer where the UDP data will be copied

len: The maximum number of bytes to read

Returns:

The actual number of bytes read from the UDP data and copied into 'buffer'

'0' if no data was read or available

'-1' if an error occured

AdafruitUDP.parsePacket() must be called BEFORE this function.

This function must be called AFTER AdafruitUDP.parsePacket()!