sync Udp.h with ESP8266

Apply update from ESP8266: add: - public `virtual ~UDP() {};` - protected `const uint8_t* rawIPAddress(const IPAddress& addr) {…}`
arduino · Oct 27, 2024 · ece85e8 · ece85e8
1 parent c8c514c
commit ece85e8
Showing 1 changed file with 50 additions and 42 deletions.
diff --git a/cores/arduino/Udp.h b/cores/arduino/Udp.h
@@ -38,52 +38,60 @@
 #include <Stream.h>
 #include <IPAddress.h>
 
-class UDP : public Stream {
+class UDP: public Stream {
 
-public:
-  virtual uint8_t begin(uint16_t) =0;  // initialize, start listening on specified port. Returns 1 if successful, 0 if there are no sockets available to use
-  virtual uint8_t beginMulticast(IPAddress, uint16_t) { return 0; }  // initialize, start listening on specified multicast IP address and port. Returns 1 if successful, 0 on failure
-  virtual void stop() =0;  // Finish with the UDP socket
+    public:
+        virtual ~UDP() {};
+        virtual uint8_t begin(uint16_t) =0;	// initialize, start listening on specified port. Returns 1 if successful, 0 if there are no sockets available to use
+        virtual uint8_t beginMulticast(IPAddress, uint16_t) { return 0; }  // initialize, start listening on specified multicast IP address and port. Returns 1 if successful, 0 on failure
+        virtual void stop() =0;  // 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
-  virtual int beginPacket(IPAddress ip, uint16_t port) =0;
-  // 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
-  virtual int beginPacket(const char *host, uint16_t port) =0;
-  // Finish off this packet and send it
-  // Returns 1 if the packet was sent successfully, 0 if there was an error
-  virtual int endPacket() =0;
-  // Write a single byte into the packet
-  virtual size_t write(uint8_t) =0;
-  // Write size bytes from buffer into the packet
-  virtual size_t write(const uint8_t *buffer, size_t size) =0;
+        // Sending UDP packets
 
-  // Start processing the next available incoming packet
-  // Returns the size of the packet in bytes, or 0 if no packets are available
-  virtual int parsePacket() =0;
-  // Number of bytes remaining in the current packet
-  virtual int available() =0;
-  // Read a single byte from the current packet
-  virtual int read() =0;
-  // 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
-  virtual int read(unsigned char* buffer, size_t len) =0;
-  // 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
-  virtual int read(char* buffer, size_t len) =0;
-  // Return the next byte from the current packet without moving on to the next byte
-  virtual int peek() =0;
-  virtual void flush() =0;	// Finish reading the current packet
+        // 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
+        virtual int beginPacket(IPAddress ip, uint16_t port) =0;
+        // 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
+        virtual int beginPacket(const char *host, uint16_t port) =0;
+        // Finish off this packet and send it
+        // Returns 1 if the packet was sent successfully, 0 if there was an error
+        virtual int endPacket() =0;
+        // Write a single byte into the packet
+        virtual size_t write(uint8_t) =0;
+        // Write size bytes from buffer into the packet
+        virtual size_t write(const uint8_t *buffer, size_t size) =0;
 
-  // Return the IP address of the host who sent the current incoming packet
-  virtual IPAddress remoteIP() =0;
-  // Return the port of the host who sent the current incoming packet
-  virtual uint16_t remotePort() =0;
-protected:
-  uint8_t* rawIPAddress(IPAddress& addr) { return addr.raw_address(); };
+        // Start processing the next available incoming packet
+        // Returns the size of the packet in bytes, or 0 if no packets are available
+        virtual int parsePacket() =0;
+        // Number of bytes remaining in the current packet
+        virtual int available() =0;
+        // Read a single byte from the current packet
+        virtual int read() =0;
+        // 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
+        virtual int read(unsigned char* buffer, size_t len) =0;
+        // 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
+        virtual int read(char* buffer, size_t len) =0;
+        // Return the next byte from the current packet without moving on to the next byte
+        virtual int peek() =0;
+        virtual void flush() =0;	// Finish reading the current packet
+
+        // Return the IP address of the host who sent the current incoming packet
+        virtual IPAddress remoteIP() =0;
+        // Return the port of the host who sent the current incoming packet
+        virtual uint16_t remotePort() =0;
+    protected:
+
+        uint8_t* rawIPAddress(IPAddress& addr) {
+            return addr.raw_address();
+        }
+
+        const uint8_t* rawIPAddress(const IPAddress& addr) {
+            return addr.raw_address();
+        }
 };
 
 #endif