Skip to content

Commit 76fe3bf

Browse files
update doc for class UDP
1 parent 58ea1cf commit 76fe3bf

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/Arduino_10BASE_T1S_UDP.h

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,28 @@
3333
* CLASS DECLARATION
3434
**************************************************************************************/
3535

36+
3637
class Arduino_10BASE_T1S_UDP : public UDP
3738
{
3839
public:
3940
/**
4041
* @class Arduino_10BASE_T1S_UDP
4142
* @brief UDP communication class for Arduino 10BASE-T1S library.
43+
*
44+
* This class provides an implementation of the UDP protocol for the Arduino 10BASE-T1S library.
45+
* It enables sending and receiving UDP packets over a 10BASE-T1S Ethernet interface, supporting
46+
* both transmission and reception of data. The class inherits from the standard Arduino UDP base
47+
* class, and overrides its methods to provide the necessary functionality for packet management,
48+
* buffer handling, and communication with the underlying hardware.
49+
*
50+
* Features:
51+
* - Initialization and termination of UDP sockets.
52+
* - Sending UDP packets to specified IP addresses or hostnames and ports.
53+
* - Receiving UDP packets, with support for buffer management and packet queueing.
54+
* - Access to remote sender's IP address and port for received packets.
55+
* - Internal buffer size configuration for received packets.
56+
*
57+
* @note This class is intended for use with the Arduino 10BASE-T1S library and is not a general-purpose UDP implementation.
4258
*/
4359
Arduino_10BASE_T1S_UDP();
4460
virtual ~Arduino_10BASE_T1S_UDP();

0 commit comments

Comments
 (0)