You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api.md
+36-36Lines changed: 36 additions & 36 deletions
Original file line number
Diff line number
Diff line change
@@ -872,7 +872,7 @@ void loop()
872
872
}
873
873
```
874
874
875
-
### `begin()`
875
+
### `server.begin()`
876
876
877
877
#### Description
878
878
@@ -931,7 +931,7 @@ void loop()
931
931
}
932
932
```
933
933
934
-
### `accept()`
934
+
### `server.accept()`
935
935
936
936
#### Description
937
937
@@ -1015,7 +1015,7 @@ void loop() {
1015
1015
}
1016
1016
```
1017
1017
1018
-
### `available()`
1018
+
### `server.available()`
1019
1019
1020
1020
#### Description
1021
1021
@@ -1130,7 +1130,7 @@ void loop() {
1130
1130
}
1131
1131
```
1132
1132
1133
-
### `write()`
1133
+
### `server.write()`
1134
1134
1135
1135
#### Description
1136
1136
@@ -1197,7 +1197,7 @@ void loop()
1197
1197
}
1198
1198
```
1199
1199
1200
-
### `print()`
1200
+
### `server.print()`
1201
1201
1202
1202
#### Description
1203
1203
@@ -1222,7 +1222,7 @@ byte
1222
1222
print() will return the number of bytes written, though reading that number is optional
1223
1223
1224
1224
1225
-
### `println()`
1225
+
### `server.println()`
1226
1226
1227
1227
#### Description
1228
1228
@@ -1390,7 +1390,7 @@ void loop()
1390
1390
1391
1391
```
1392
1392
1393
-
### `connected()`
1393
+
### `client.connected()`
1394
1394
1395
1395
#### Description
1396
1396
@@ -1457,7 +1457,7 @@ void loop()
1457
1457
}
1458
1458
```
1459
1459
1460
-
### `connect()`
1460
+
### `client.connect()`
1461
1461
1462
1462
#### Description
1463
1463
@@ -1535,7 +1535,7 @@ void loop()
1535
1535
}
1536
1536
```
1537
1537
1538
-
### `localPort()`
1538
+
### `client.localPort()`
1539
1539
1540
1540
#### Description
1541
1541
@@ -1592,7 +1592,7 @@ void loop() {
1592
1592
}
1593
1593
```
1594
1594
1595
-
### `remoteIP()`
1595
+
### `client.remoteIP()`
1596
1596
1597
1597
#### Description
1598
1598
@@ -1649,7 +1649,7 @@ void loop() {
1649
1649
}
1650
1650
```
1651
1651
1652
-
### `remotePort()`
1652
+
### `client.remotePort()`
1653
1653
1654
1654
#### Description
1655
1655
@@ -1706,7 +1706,7 @@ void loop() {
1706
1706
}
1707
1707
```
1708
1708
1709
-
### `setConnectionTimeout()`
1709
+
### `client.setConnectionTimeout()`
1710
1710
1711
1711
#### Description
1712
1712
@@ -1761,7 +1761,7 @@ void loop() {
1761
1761
}
1762
1762
```
1763
1763
1764
-
### `write()`
1764
+
### `client.write()`
1765
1765
1766
1766
#### Description
1767
1767
@@ -1809,7 +1809,7 @@ BASE (optional): the base in which to print numbers: DEC for decimal (base 10),
1809
1809
#### Returns
1810
1810
byte: returns the number of bytes written, though reading that number is optional
1811
1811
1812
-
### `println()`
1812
+
### `client.println()`
1813
1813
1814
1814
#### Description
1815
1815
@@ -1834,7 +1834,7 @@ BASE (optional): the base in which to print numbers: DEC for decimal (base 10),
1834
1834
byte: return the number of bytes written, though reading that number is optional
1835
1835
1836
1836
1837
-
### `available()`
1837
+
### `client.available()`
1838
1838
1839
1839
#### Description
1840
1840
@@ -1903,7 +1903,7 @@ void loop()
1903
1903
}
1904
1904
```
1905
1905
1906
-
### `read()`
1906
+
### `client.read()`
1907
1907
1908
1908
#### Description
1909
1909
@@ -1925,7 +1925,7 @@ none
1925
1925
#### Returns
1926
1926
The next byte (or character), or -1 if none is available.
1927
1927
1928
-
flush()
1928
+
### `client.flush()`
1929
1929
Waits until all outgoing characters in buffer have been sent.
1930
1930
1931
1931
flush() inherits from the Stream utility class.
@@ -1944,7 +1944,7 @@ none
1944
1944
#### Returns
1945
1945
none
1946
1946
1947
-
### `stop()`
1947
+
### `client.stop()`
1948
1948
1949
1949
#### Description
1950
1950
@@ -1964,9 +1964,9 @@ none
1964
1964
#### Returns
1965
1965
none
1966
1966
1967
-
# EthernetUDP Class
1967
+
##EthernetUDP Class
1968
1968
1969
-
### `UDP.begin()`
1969
+
### `EthernetUDP.begin()`
1970
1970
1971
1971
#### Description
1972
1972
Initializes the ethernet UDP library and network settings.
@@ -2038,7 +2038,7 @@ void loop() {
2038
2038
2039
2039
```
2040
2040
2041
-
### `UDP.read()`
2041
+
### `EthernetUDP.read()`
2042
2042
2043
2043
#### Description
2044
2044
Reads UDP data from the specified buffer. If no arguments are given, it will return the next character in the buffer.
@@ -2049,8 +2049,8 @@ This function can only be successfully called after UDP.parsePacket().
2049
2049
#### Syntax
2050
2050
2051
2051
```
2052
-
UDP.read();
2053
-
UDP.read(packetBuffer, MaxSize);
2052
+
EthernetUDP.read();
2053
+
EthernetUDP.read(packetBuffer, MaxSize);
2054
2054
```
2055
2055
2056
2056
#### Parameters
@@ -2115,7 +2115,7 @@ void loop() {
2115
2115
}
2116
2116
```
2117
2117
2118
-
### `UDP.write()`
2118
+
### `EthernetUDP.write()`
2119
2119
2120
2120
#### Description
2121
2121
Writes UDP data to the remote connection. Must be wrapped between beginPacket() and endPacket(). beginPacket() initializes the packet of data, it is not sent until endPacket() is called.
@@ -2124,8 +2124,8 @@ Writes UDP data to the remote connection. Must be wrapped between beginPacket()
2124
2124
#### Syntax
2125
2125
2126
2126
```
2127
-
UDP.write(message);
2128
-
UDP.write(buffer, size);
2127
+
EthernetUDP.write(message);
2128
+
EthernetUDP.write(buffer, size);
2129
2129
2130
2130
```
2131
2131
@@ -2199,7 +2199,7 @@ void loop() {
2199
2199
2200
2200
```
2201
2201
2202
-
### `UDP.beginPacket()`
2202
+
### `EthernetUDP.beginPacket()`
2203
2203
2204
2204
#### Description
2205
2205
Starts a connection to write UDP data to the remote connection
@@ -2208,7 +2208,7 @@ Starts a connection to write UDP data to the remote connection
2208
2208
#### Syntax
2209
2209
2210
2210
```
2211
-
UDP.beginPacket(remoteIP, remotePort);
2211
+
EthernetUDP.beginPacket(remoteIP, remotePort);
2212
2212
```
2213
2213
2214
2214
#### Parameters
@@ -2251,7 +2251,7 @@ void loop() {
2251
2251
}
2252
2252
```
2253
2253
2254
-
### `UDP.endPacket()`
2254
+
### `EthernetUDP.endPacket()`
2255
2255
2256
2256
#### Description
2257
2257
Called after writing UDP data to the remote connection.
@@ -2260,7 +2260,7 @@ Called after writing UDP data to the remote connection.
2260
2260
#### Syntax
2261
2261
2262
2262
```
2263
-
UDP.endPacket();
2263
+
EthernetUDP.endPacket();
2264
2264
```
2265
2265
2266
2266
#### Parameters
@@ -2303,7 +2303,7 @@ void loop() {
2303
2303
}
2304
2304
```
2305
2305
2306
-
### `UDP.parsePacket()`
2306
+
### `EthernetUDP.parsePacket()`
2307
2307
2308
2308
#### Description
2309
2309
Checks for the presence of a UDP packet, and reports the size. parsePacket() must be called before reading the buffer with UDP.read().
@@ -2312,7 +2312,7 @@ Checks for the presence of a UDP packet, and reports the size. parsePacket() mus
2312
2312
#### Syntax
2313
2313
2314
2314
```
2315
-
UDP.parsePacket();
2315
+
EthernetUDP.parsePacket();
2316
2316
```
2317
2317
2318
2318
#### Parameters
@@ -2361,7 +2361,7 @@ void loop() {
2361
2361
}
2362
2362
```
2363
2363
2364
-
### `UDP.available()`
2364
+
### `EthernetUDP.available()`
2365
2365
2366
2366
#### Description
2367
2367
@@ -2375,7 +2375,7 @@ available() inherits from the Stream utility class.
2375
2375
#### Syntax
2376
2376
2377
2377
```
2378
-
UDP.available()
2378
+
EthernetUDP.available()
2379
2379
2380
2380
```
2381
2381
@@ -2442,7 +2442,7 @@ void loop() {
2442
2442
2443
2443
## UDP class
2444
2444
2445
-
### `EthernetUDP.stop()`
2445
+
### `UDP.stop()`
2446
2446
2447
2447
#### Description
2448
2448
@@ -2452,7 +2452,7 @@ Disconnect from the server. Release any resource being used during the UDP sessi
0 commit comments