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: libraries/WiFiS3/docs/api.md
+22-22
Original file line number
Diff line number
Diff line change
@@ -41,8 +41,8 @@ It inherits from the Client class, providing basic socket communication function
41
41
| [`stop`](#class_wi_fi_client_1acb61f8e0ecd50e40ce6cbcb7106ce1b1) | Closes the connection to the server and clears the receive buffer. |
42
42
| [`connected`](#class_wi_fi_client_1af083fe27b94aebec37f140c0b973f974) | Checks if the client is connected to a server. |
43
43
| [`operator bool`](#class_wi_fi_client_1adaf93736006b5bb2426e9816de4207eb) | Implicit conversion operator to `bool`. |
44
-
| [`operator==`](#class_wi_fi_client_1ac1e068fb2468d84536e93f6e1b51b099) | Equality operator for comparing two `[WiFiClient](#class_wi_fi_client)` objects. |
45
-
| [`operator!=`](#class_wi_fi_client_1a31b6e43ab5ab9d6fe511778a5a1f173c) | Inequality operator for comparing two `[WiFiClient](#class_wi_fi_client)` objects. |
44
+
| [`operator==`](#class_wi_fi_client_1ac1e068fb2468d84536e93f6e1b51b099) | Equality operator for comparing two [WiFiClient](#class_wi_fi_client) objects. |
45
+
| [`operator!=`](#class_wi_fi_client_1a31b6e43ab5ab9d6fe511778a5a1f173c) | Inequality operator for comparing two [WiFiClient](#class_wi_fi_client) objects. |
46
46
| [`remoteIP`](#class_wi_fi_client_1a46d45c8d326b62256f85d55eaa337df0) | Retrieves the remote IP address of the server the client is connected to. |
47
47
| [`remotePort`](#class_wi_fi_client_1a38ca1399ebf6570d2c852c9062ec92d8) | Retrieves the remote port number of the server the client is connected to. |
48
48
| [`setConnectionTimeout`](#class_wi_fi_client_1af32938f36f09c9121e85e38338d432d7) | Sets the connection timeout for the client. |
@@ -80,7 +80,7 @@ WiFiClient(const WiFiClient & c)
80
80
Copy constructor for the [WiFiClient](#class_wi_fi_client) class.
81
81
82
82
#### Parameters
83
-
*`c` is the `[WiFiClient](#class_wi_fi_client)` object to copy.
83
+
*`c` is the [WiFiClient](#class_wi_fi_client) object to copy.
Converts the `[WiFiClient](#class_wi_fi_client)` object to a `bool` value indicating whether the client is connected or not.
256
+
Converts the [WiFiClient](#class_wi_fi_client) object to a `bool` value indicating whether the client is connected or not.
257
257
258
258
#### Returns
259
259
`true` if the client socket is open and valid, `false` otherwise.
@@ -265,15 +265,15 @@ Converts the `[WiFiClient](#class_wi_fi_client)` object to a `bool` value indica
265
265
virtualbooloperator==(const WiFiClient &)
266
266
```
267
267
268
-
Equality operator for comparing two `[WiFiClient](#class_wi_fi_client)` objects.
268
+
Equality operator for comparing two [WiFiClient](#class_wi_fi_client) objects.
269
269
270
-
Compares the current `[WiFiClient](#class_wi_fi_client)` object with another `[WiFiClient](#class_wi_fi_client)` object to determine if they represent the same socket connection.
270
+
Compares the current [WiFiClient](#class_wi_fi_client) object with another [WiFiClient](#class_wi_fi_client) object to determine if they represent the same socket connection.
271
271
272
272
#### Parameters
273
-
*`The``[WiFiClient](#class_wi_fi_client)` object to compare with.
273
+
*`The`[WiFiClient](#class_wi_fi_client) object to compare with.
274
274
275
275
#### Returns
276
-
`true` if both `[WiFiClient](#class_wi_fi_client)` objects represent the same socket, `false` otherwise.
276
+
`true` if both [WiFiClient](#class_wi_fi_client) objects represent the same socket, `false` otherwise.
Inequality operator for comparing two `[WiFiClient](#class_wi_fi_client)` objects.
285
+
Inequality operator for comparing two [WiFiClient](#class_wi_fi_client) objects.
286
286
287
-
Compares the current `[WiFiClient](#class_wi_fi_client)` object with another `[WiFiClient](#class_wi_fi_client)` object to determine if they represent different socket connections.
287
+
Compares the current [WiFiClient](#class_wi_fi_client) object with another [WiFiClient](#class_wi_fi_client) object to determine if they represent different socket connections.
288
288
289
289
#### Parameters
290
-
*`whs` is the `[WiFiClient](#class_wi_fi_client)` object to compare with.
290
+
*`whs` is the [WiFiClient](#class_wi_fi_client) object to compare with.
291
291
292
292
#### Returns
293
293
`true` if both [WiFiClient](#class_wi_fi_client) objects represent different sockets, `false` if they represent the same socket.
@@ -457,7 +457,7 @@ WiFiClient available()
457
457
458
458
Checks if there are any incoming client connections waiting to be accepted.
459
459
460
-
This function queries the server to check if there is a client waiting to be accepted. If a client is available, it returns a `[WiFiClient](#class_wi_fi_client)` object representing the client. It uses the modem to query the server for an available client socket and accepts the connection if a valid client is found.
460
+
This function queries the server to check if there is a client waiting to be accepted. If a client is available, it returns a [WiFiClient](#class_wi_fi_client) object representing the client. It uses the modem to query the server for an available client socket and accepts the connection if a valid client is found.
461
461
462
462
#### Returns
463
463
Returns a [WiFiClient](#class_wi_fi_client) object representing the next client connection that is available for processing.
Compares two [WiFiServer](#class_wi_fi_server) objects for equality.
562
562
563
-
This virtual operator compares the underlying socket (`_sock`) of two `[WiFiServer](#class_wi_fi_server)` objects to determine if they refer to the same server connection.
563
+
This virtual operator compares the underlying socket (`_sock`) of two [WiFiServer](#class_wi_fi_server) objects to determine if they refer to the same server connection.
564
564
565
565
#### Parameters
566
-
*`[WiFiServer](#class_wi_fi_server)` object to compare against.
566
+
*[WiFiServer](#class_wi_fi_server) object to compare against.
567
567
568
568
#### Returns
569
569
`true` if both [WiFiServer](#class_wi_fi_server) objects have the same socket; `false` otherwise.
@@ -617,8 +617,8 @@ The [WiFiSSLClient](#class_wi_fi_s_s_l_client) class extends the functionality o
617
617
| [`stop`](#class_wi_fi_s_s_l_client_1a66113af6fbc85f0dbb73f8d276b8a77a) | Terminates the SSL/TLS connection and clears the receive buffer. |
618
618
| [`connected`](#class_wi_fi_s_s_l_client_1a5e993c746855bb67c744d27baa6cf1bb) | Checks if the SSL/TLS connection is active. |
619
619
| [`operator bool`](#class_wi_fi_s_s_l_client_1a46888795cc1562c33fad408b57d2ad40) | Implicit conversion operator to check if the SSL client is connected. |
620
-
| [`operator==`](#class_wi_fi_s_s_l_client_1aa0bdf11dd3e6ef48133967dc0a036004) | Comparison operator to check equality between two `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` objects. |
621
-
| [`operator!=`](#class_wi_fi_s_s_l_client_1a2cdd8020168fae9e08d3c6d00b30b065) | Inequality operator to compare two `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` objects. |
620
+
| [`operator==`](#class_wi_fi_s_s_l_client_1aa0bdf11dd3e6ef48133967dc0a036004) | Comparison operator to check equality between two [WiFiSSLClient](#class_wi_fi_s_s_l_client) objects. |
621
+
| [`operator!=`](#class_wi_fi_s_s_l_client_1a2cdd8020168fae9e08d3c6d00b30b065) | Inequality operator to compare two [WiFiSSLClient](#class_wi_fi_s_s_l_client) objects. |
622
622
| [`remoteIP`](#class_wi_fi_s_s_l_client_1acff0aa8078124dff0c0ff3bfee7cfd83) | Retrieves the remote IP address of the WiFi SSL client. |
623
623
| [`remotePort`](#class_wi_fi_s_s_l_client_1aea76ab94b3cdfec17ab6e73c7b169da7) | Retrieves the remote port number of the WiFi SSL client. |
624
624
@@ -838,7 +838,7 @@ Implicit conversion operator to check if the SSL client is connected.
838
838
virtualbooloperator==(const WiFiSSLClient &)
839
839
```
840
840
841
-
Comparison operator to check equality between two `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` objects.
841
+
Comparison operator to check equality between two [WiFiSSLClient](#class_wi_fi_s_s_l_client) objects.
842
842
843
843
#### Parameters
844
844
*`WiFiSSLClient` object to compare.
@@ -853,9 +853,9 @@ Comparison operator to check equality between two `[WiFiSSLClient](#class_wi_fi_
Inequality operator to compare two `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` objects.
856
+
Inequality operator to compare two [WiFiSSLClient](#class_wi_fi_s_s_l_client) objects.
857
857
858
-
This operator compares the current `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` object with another `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` object to determine if they are not equal, based on their underlying socket or connection.
858
+
This operator compares the current [WiFiSSLClient](#class_wi_fi_s_s_l_client) object with another [WiFiSSLClient](#class_wi_fi_s_s_l_client) object to determine if they are not equal, based on their underlying socket or connection.
859
859
860
860
#### Parameters
861
861
*`whs` The [WiFiSSLClient](#class_wi_fi_s_s_l_client) object to compare with.
Retrieves the remote IP address of the host who sent the current incoming packet.
1227
1227
1228
1228
#### Returns
1229
-
An `IPAddress` object representing the remote IP address. If the socket is not valid or the address cannot be retrieved, it returns `IPAddress(0, 0, 0, 0)`.
1229
+
An `IPAddress` object representing the remote IP address. If the socket is not valid or the address cannot be retrieved, it returns `IPAddress(0, 0, 0, 0).
0 commit comments