UIPEthernet library for Arduino IDE, Eclipse with arduino plugin and MBED/SMeshStudio (AVR,STM32F,ESP8266,Intel ARC32,Nordic nRF51,Teensy boards,Realtek Ameba(RTL8195A,RTL8710)), ENC28j60 network chip. Compatible with Wiznet W5100 Ethernet library API. Compiled and tested on Nucleo-F302R8. Master repository is: https://github.com/UIPEthernet/UIPEthernet/
Diff: UIPUdp.h
- Revision:
- 4:5c7337d5ba8e
- Parent:
- 3:6b1c9bd7773a
- Child:
- 8:b9332109461d
--- a/UIPUdp.h Tue Dec 27 12:49:39 2016 +0100 +++ b/UIPUdp.h Tue Dec 27 12:52:31 2016 +0100 @@ -2,24 +2,24 @@ UIPUdp.h - Arduino implementation of a uIP wrapper class Copyright (c) 2013 Norbert Truchsess <norbert.truchsess@t-online.de> All rights reserved. - + This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - + You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. */ - + #ifndef UIPUDP_H #define UIPUDP_H - + #include "ethernet_comp.h" #if defined(__MBED__) #include <mbed.h> @@ -33,11 +33,11 @@ extern "C" { #include "utility/uip.h" } - + #define UIP_UDP_MAXDATALEN 1500 #define UIP_UDP_PHYH_LEN UIP_LLH_LEN+UIP_IPUDPH_LEN #define UIP_UDP_MAXPACKETSIZE UIP_UDP_MAXDATALEN+UIP_UDP_PHYH_LEN - + typedef struct { memaddress out_pos; memhandle packet_next; @@ -45,89 +45,73 @@ memhandle packet_out; bool send; } uip_udp_userdata_t; - + class UIPUDP : public UDP { - + private: struct uip_udp_conn *_uip_udp_conn; - + uip_udp_userdata_t appdata; - + public: - UIPUDP(void); // Constructor - uint8_t - begin(uint16_t);// initialize, start listening on specified port. Returns 1 if successful, 0 if there are no sockets available to use - void - stop(void); // Finish with the UDP socket - + UIPUDP(void); // Constructor + virtual uint8_t begin(uint16_t);// initialize, start listening on specified port. Returns 1 if successful, 0 if there are no sockets available to use + virtual void stop(void); // Finish with the UDP socket + // Sending UDP packets - + // Start building up a packet to send to the remote host specific in ip and port // Returns 1 if successful, 0 if there was a problem with the supplied IP address or port - int - beginPacket(IPAddress ip, uint16_t port); + virtual int beginPacket(IPAddress ip, uint16_t port); // Start building up a packet to send to the remote host specific in host and port // Returns 1 if successful, 0 if there was a problem resolving the hostname or port - int - beginPacket(const char *host, uint16_t port); + virtual int beginPacket(const char *host, uint16_t port); // Finish off this packet and send it // Returns 1 if the packet was sent successfully, 0 if there was an error - int - endPacket(void); + virtual int endPacket(void); // Write a single byte into the packet - size_t - write(uint8_t); + virtual size_t write(uint8_t); // Write size bytes from buffer into the packet - size_t - write(const uint8_t *buffer, size_t size); - + virtual size_t write(const uint8_t *buffer, size_t size); + #if defined(ARDUINO) - using Print::write; + using Print::write; #endif // Start processing the next available incoming packet // Returns the size of the packet in bytes, or 0 if no packets are available - int - parsePacket(void); + virtual int parsePacket(void); // Number of bytes remaining in the current packet - int - available(void); + virtual int available(void); // Read a single byte from the current packet - int - read(void); + virtual int read(void); // Read up to len bytes from the current packet and place them into buffer // Returns the number of bytes read, or 0 if none are available - int - read(unsigned char* buffer, size_t len); + virtual int read(unsigned char* buffer, size_t len); // Read up to len characters from the current packet and place them into buffer // Returns the number of characters read, or 0 if none are available - int - read(char* buffer, size_t len) + virtual int read(char* buffer, size_t len) { return read((unsigned char*) buffer, len); } ; // Return the next byte from the current packet without moving on to the next byte - int - peek(void); - void - flush(void); // Finish reading the current packet - + virtual int peek(void); + virtual void flush(void); // Finish reading the current packet + // Return the IP address of the host who sent the current incoming packet - IPAddress - remoteIP(void); - + virtual IPAddress remoteIP(void); + // Return the port of the host who sent the current incoming packet - uint16_t - remotePort(void); - + virtual uint16_t remotePort(void); + private: - + friend void uipudp_appcall(void); - + friend class UIPEthernetClass; static void _send(uip_udp_userdata_t *data); - + }; - + #endif