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
Establishes a connection to a server using a hostname and port.
120
120
121
121
#### Parameters
122
-
*`<tt>host</tt>` is a pointer to a null-terminated string containing the hostname of the server.
122
+
*`host` is a pointer to a null-terminated string containing the hostname of the server.
123
123
124
-
*`<tt>port</tt>` is the port number on the server to connect to.
124
+
*`port` is the port number on the server to connect to.
125
125
126
126
#### Returns
127
127
`1` if the connection was successful, `0` otherwise.
@@ -136,7 +136,7 @@ virtual size_t write(uint8_t)
136
136
Sends a single byte of data to the connected server.
137
137
138
138
#### Parameters
139
-
* `<tt>b</tt>` being the byte of data to send.
139
+
* `b` being the byte of data to send.
140
140
141
141
#### Returns
142
142
The number of bytes successfully written, which is `1` on success or `0` on failure.
@@ -192,9 +192,9 @@ Reads multiple bytes of data from the server into a buffer.
192
192
This function retrieves data from the server's receive buffer and stores it into the provided array. It attempts to read up to the specified number of bytes (`size`).
193
193
194
194
#### Parameters
195
-
* `<tt>buf</tt>` is a pointer to the buffer where the data will be stored.
195
+
* `buf` is a pointer to the buffer where the data will be stored.
196
196
197
-
* `<tt>size</tt>` is the maximum number of bytes to read.
197
+
* `size` is the maximum number of bytes to read.
198
198
199
199
#### Returns
200
200
The number of bytes successfully read into the buffer. Returns `0` if no data is available or if the socket is invalid.
@@ -287,7 +287,7 @@ Inequality operator for comparing two `[WiFiClient](#class_wi_fi_client)` object
287
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
-
*`<tt>whs</tt>` 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.
*`<tt>name</tt>` is the name of the file to which the data will be written. A pointer `data` to the data that will be written to the file. `size` is the number of bytes to write from the provided data buffer. `operation` determines the type of file operation to perform (e.g., create, overwrite).
380
+
*`name` is the name of the file to which the data will be written. A pointer `data` to the data that will be written to the file. `size` is the number of bytes to write from the provided data buffer. `operation` determines the type of file operation to perform (e.g., create, overwrite).
381
381
382
382
#### Returns
383
383
Returns the number of bytes successfully written. Returns 0 if the operation fails.
@@ -394,7 +394,7 @@ Reads a file from the file system and prints its content.
394
394
It sends the read request to the modem, which fetches the data. The content is printed to the serial output in chunks, with each chunk being processed until the entire file is read.
395
395
396
396
#### Parameters
397
-
* `<tt>name</tt>` is the name of the file to be read from the file system.
397
+
* `name` is the name of the file to be read from the file system.
398
398
<hr />
399
399
400
400
# class `WiFiServer` <a id="class_wi_fi_server" class="anchor"></a>
@@ -446,7 +446,7 @@ WiFiServer(int p)
446
446
Constructs a [WiFiServer](#class_wi_fi_server) object with the specified port.
447
447
448
448
#### Parameters
449
-
* `<tt>p</tt>` The port number on which the server will listen for incoming connections.
449
+
* `p` The port number on which the server will listen for incoming connections.
@@ -521,7 +521,7 @@ Writes data to all connected clients.
521
521
This function sends a buffer of data to all clients connected to the server. It writes the specified number of bytes to the server socket and returns the count of successfully written bytes.
522
522
523
523
#### Parameters
524
-
*`<tt>buf</tt>` is a pointer to the buffer containing the data to be sent. `size` is the number of bytes to write from the buffer.
524
+
*`buf` is a pointer to the buffer containing the data to be sent. `size` is the number of bytes to write from the buffer.
525
525
526
526
#### Returns
527
527
The number of bytes successfully written. Returns 0 if the data could not be sent.
@@ -580,7 +580,7 @@ Compares two [WiFiServer](#class_wi_fi_server) objects for inequality.
580
580
This virtual operator compares the underlying socket (`_sock`) of two [WiFiServer](#class_wi_fi_server) objects. It returns `true` if the objects do not refer to the same server connection (i.e., they have different socket values), and `false` otherwise.
581
581
582
582
#### Parameters
583
-
*`<tt>whs</tt>` The [WiFiServer](#class_wi_fi_server) object to compare against.
583
+
*`whs` The [WiFiServer](#class_wi_fi_server) object to compare against.
584
584
585
585
#### Returns
586
586
`true` if the [WiFiServer](#class_wi_fi_server) objects have different sockets; `false` otherwise.
Sets the Certificate Authority (CA) for SSL/TLS verification.
682
682
683
683
#### Parameters
684
-
* `<tt>root_ca</tt>` is a pointer to a null-terminated string containing the root CA certificate in PEM format. If set to `nullptr`, the default root CA bundle will be used.
684
+
* `root_ca` is a pointer to a null-terminated string containing the root CA certificate in PEM format. If set to `nullptr`, the default root CA bundle will be used.
Comparison operator to check equality between two `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` objects.
842
842
843
843
#### Parameters
844
-
*`<tt>WiFiSSLClient</tt>` object to compare.
844
+
*`WiFiSSLClient` object to compare.
845
845
846
846
#### Returns
847
847
`true` if both [WiFiSSLClient](#class_wi_fi_s_s_l_client) objects are equivalent (i.e., they have the same socket), `false` otherwise.
@@ -858,7 +858,7 @@ Inequality operator to compare two `[WiFiSSLClient](#class_wi_fi_s_s_l_client)`
858
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
-
*`<tt>whs</tt>` The [WiFiSSLClient](#class_wi_fi_s_s_l_client) object to compare with.
861
+
*`whs` The [WiFiSSLClient](#class_wi_fi_s_s_l_client) object to compare with.
862
862
863
863
#### Returns
864
864
`true` if the two [WiFiSSLClient](#class_wi_fi_s_s_l_client) objects do not represent the same connection (i.e., have different sockets), `false` otherwise.
Sends a buffer of data to the currently opened UDP packet.
1084
1084
1085
1085
#### Parameters
1086
-
*`<tt>buffer</tt>` A pointer to the buffer containing the data to send.
1086
+
*`buffer` A pointer to the buffer containing the data to send.
1087
1087
1088
-
*`<tt>size</tt>` The number of bytes from the buffer to write.
1088
+
*`size` The number of bytes from the buffer to write.
1089
1089
1090
1090
#### Returns
1091
1091
Returns the number of bytes successfully written if the operation is successful. Or `0` if the data was not successfully written, or if the packet was not properly initialized.
0 commit comments