Skip to content

Commit 34f296c

Browse files
codestyle unification
1 parent b8399ed commit 34f296c

File tree

2 files changed

+38
-39
lines changed

2 files changed

+38
-39
lines changed

libraries/WiFiS3/src/WiFiSSLClient.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,4 +282,4 @@ uint16_t WiFiSSLClient::remotePort(){
282282
}
283283
}
284284
return rv;
285-
}
285+
}

libraries/WiFiS3/src/WiFiSSLClient.h

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828
/**
2929
* @brief A specialized client class for secure SSL/TLS connections.
30-
*
30+
*
3131
* The WiFiSSLClient class extends the functionality of the WiFiClient class to provide secure
3232
* communication over SSL/TLS protocols. It ensures encrypted and authenticated communication
3333
* between the client and a remote server.
@@ -43,50 +43,50 @@ class WiFiSSLClient : public WiFiClient {
4343

4444
/**
4545
* @brief Establishes a secure SSL connection to a specified IP address and port.
46-
*
46+
*
4747
* @param It takes an `IPAddress` object representing the IP address of the server
4848
* and a `uint16_t` port number as parameters.
4949
*
50-
* @return Returns a status code indicating the success or failure of the
50+
* @return Returns a status code indicating the success or failure of the
5151
* connection.
5252
*/
5353
virtual int connect(IPAddress ip, uint16_t port);
5454

5555
/**
5656
* @brief Establishes a secure SSL connection to a specified host and port.
57-
*
57+
*
5858
* @param `host` is the hostname or IP address of the server to connect to.
5959
* `port` is the port number to connect to.
60-
*
60+
*
6161
* @return Returns `1` if the connection is successfully established, `0` otherwise.
6262
*/
6363
virtual int connect(const char* host, uint16_t port);
6464

6565
/**
6666
* @brief Sets the Certificate Authority (CA) for SSL/TLS verification.
6767
*
68-
* @param `root_ca` is a pointer to a null-terminated string containing the root
69-
* CA certificate in PEM format. If set to `nullptr`, the default root
68+
* @param `root_ca` is a pointer to a null-terminated string containing the root
69+
* CA certificate in PEM format. If set to `nullptr`, the default root
7070
* CA bundle will be used.
7171
*/
7272
void setCACert(const char* root_ca);
7373

7474
/**
75-
* @brief Sets the ECC (Elliptic Curve Cryptography) key slot and
75+
* @brief Sets the ECC (Elliptic Curve Cryptography) key slot and
7676
* certificate for establishing secure SSL connections.
77-
*
77+
*
7878
* @param `int ecc508KeySlot` specifies the ECC key slot to be used for the SSL connection.
7979
* @param `const byte cert[]` is a pointer to the certificate data in the form of an array of bytes.
8080
* @param `int certLength` specifies the length of the certificate data array.
8181
*/
8282
void setEccSlot(int ecc508KeySlot, const byte cert[], int certLength);
83-
83+
8484
/**
8585
* @brief Writes a single byte of data to the SSL connection.
86-
*
86+
*
8787
* @param `b` is the byte to be sent.
88-
*
89-
* @return The number of bytes successfully written. Returns `1` if the byte
88+
*
89+
* @return The number of bytes successfully written. Returns `1` if the byte
9090
* was sent successfully, or `0` if an error occurred.
9191
*/
9292
virtual size_t write(uint8_t);
@@ -97,22 +97,22 @@ class WiFiSSLClient : public WiFiClient {
9797
* @param `buf` is a pointer to the buffer containing the data to be sent.
9898
* @param `size` is the number of bytes to send from the buffer.
9999
*
100-
* @return Returns `size` if the data is successfully sent,
100+
* @return Returns `size` if the data is successfully sent,
101101
* or `0` if the transmission fails or the socket is invalid.
102102
*/
103103
virtual size_t write(const uint8_t *buf, size_t size);
104-
104+
105105
/**
106106
* @brief Checks the number of bytes available for reading from the SSL connection.
107-
*
107+
*
108108
* @return Returns the number of bytes available to read from the SSL connection without blocking.
109109
*/
110110
virtual int available();
111111

112112
/**
113113
* @brief Reads data from the SSL connection into the receive buffer.
114114
*
115-
* @return Returns the number of bytes successfully read into the buffer. Returns
115+
* @return Returns the number of bytes successfully read into the buffer. Returns
116116
* `0` if no data is received, or `-1` if the socket is invalid or an error occurs.
117117
*/
118118
virtual int read();
@@ -123,26 +123,26 @@ class WiFiSSLClient : public WiFiClient {
123123
* @param `buf` is a pointer to the buffer where the read data will be stored.
124124
* `size` is the maximum number of bytes to read into the buffer.
125125
*
126-
* @return The number of bytes successfully read. Returns `0` if no data is
126+
* @return The number of bytes successfully read. Returns `0` if no data is
127127
* available or an error occurs.
128128
*/
129129
virtual int read(uint8_t *buf, size_t size);
130130

131131
/**
132132
* @brief Peeks at the next byte available from the SSL connection without removing it.
133133
*
134-
* This function queries the modem to retrieve the next byte available in the
134+
* This function queries the modem to retrieve the next byte available in the
135135
* SSL/TLS connection, allowing the byte to remain in the buffer for future reads.
136136
*
137-
* @return The next byte available as an integer value (0–255), or `-1` if
137+
* @return The next byte available as an integer value (0–255), or `-1` if
138138
* the socket is invalid or no data is available.
139139
*/
140140
virtual int peek();
141141

142142
/**
143143
* @brief Flushes the write buffer of the SSL connection.
144-
*
145-
* This function clears the write buffer, ensuring that any pending data is sent
144+
*
145+
* This function clears the write buffer, ensuring that any pending data is sent
146146
* over the SSL/TLS connection. It uses the modem to handle the flush operation.
147147
*/
148148
virtual void flush();
@@ -155,8 +155,8 @@ class WiFiSSLClient : public WiFiClient {
155155
/**
156156
* @brief Checks if the SSL/TLS connection is active.
157157
*
158-
* This function determines if the SSL/TLS client is still connected by querying
159-
* the modem for the connection status. It checks the validity of the socket
158+
* This function determines if the SSL/TLS client is still connected by querying
159+
* the modem for the connection status. It checks the validity of the socket
160160
* before proceeding with the query.
161161
*
162162
* @return Returns `1` if the client is connected, `0` otherwise.
@@ -165,7 +165,7 @@ class WiFiSSLClient : public WiFiClient {
165165

166166
/**
167167
* @brief Implicit conversion operator to check if the SSL client is connected.
168-
*
168+
*
169169
* @return `true` if the socket is valid (i.e., connected), `false` otherwise.
170170
*/
171171
virtual operator bool() {
@@ -174,20 +174,20 @@ class WiFiSSLClient : public WiFiClient {
174174

175175
/**
176176
* @brief Comparison operator to check equality between two `WiFiSSLClient` objects.
177-
*
177+
*
178178
* @param `WiFiSSLClient` object to compare.
179-
*
179+
*
180180
* @return `true` if both WiFiSSLClient objects are equivalent (i.e., they have the same socket),
181181
* `false` otherwise.
182182
*/
183183
virtual bool operator==(const WiFiSSLClient&);
184184

185185
/**
186186
* @brief Inequality operator to compare two `WiFiSSLClient` objects.
187-
*
187+
*
188188
* This operator compares the current `WiFiSSLClient` object with another `WiFiSSLClient` object
189189
* to determine if they are not equal, based on their underlying socket or connection.
190-
*
190+
*
191191
* @param `whs` The WiFiSSLClient object to compare with.
192192
* @return `true` if the two WiFiSSLClient objects do not represent the same connection (i.e., have different sockets),
193193
* `false` otherwise.
@@ -200,38 +200,37 @@ class WiFiSSLClient : public WiFiClient {
200200
/**
201201
* @brief Retrieves the remote IP address of the WiFi SSL client.
202202
*
203-
* This function queries the modem for the remote IP address associated with
203+
* This function queries the modem for the remote IP address associated with
204204
* the current connection.
205205
*
206-
* @return The remote IP address of the client. Returns `0.0.0.0` if the
206+
* @return The remote IP address of the client. Returns `0.0.0.0` if the
207207
* socket is not valid or the query fails.
208208
*/
209209
virtual IPAddress remoteIP();
210210

211211
/**
212212
* @brief Retrieves the remote port number of the WiFi SSL client.
213213
*
214-
* This function queries the modem to obtain the remote port number associated
214+
* This function queries the modem to obtain the remote port number associated
215215
* with the current connection.
216216
*
217-
* @return Returns the remote port number of the client. Returns `0` if the socket
217+
* @return Returns the remote port number of the client. Returns `0` if the socket
218218
* is not valid or the query fails.
219219
*/
220220
virtual uint16_t remotePort();
221221

222-
223222
/**
224223
* @brief Declares WiFiServer as a friend class.
225-
*
226-
* This allows the WiFiServer class to access private and protected members
224+
*
225+
* This allows the WiFiServer class to access private and protected members
227226
* of the WiFiSSLClient class.
228227
*/
229228
friend class WiFiServer;
230229

231230
/**
232231
* @brief Inherits the `write` method from the Print class.
233-
*
234-
* This allows the WiFiSSLClient class to use the `write` method defined in the
232+
*
233+
* This allows the WiFiSSLClient class to use the `write` method defined in the
235234
* Print class.
236235
*/
237236
using Print::write;

0 commit comments

Comments
 (0)