File tree Expand file tree Collapse file tree 6 files changed +26
-4
lines changed Expand file tree Collapse file tree 6 files changed +26
-4
lines changed Original file line number Diff line number Diff line change @@ -100,3 +100,5 @@ class DNS {
100
100
};
101
101
102
102
#endif
103
+
104
+ /* * @} */
Original file line number Diff line number Diff line change 30
30
#if defined(MBEDTLS_SSL_CLI_C) || defined(DOXYGEN_ONLY)
31
31
32
32
/* *
33
- * \brief DTLSSocket implement DTLS stream over the existing Socket transport
33
+ * \brief DTLSSocket implement DTLS stream over UDP Socket.
34
+ *
35
+ * This is a easy to use helper class that uses DTLSSocketWrapper with
36
+ * internal UDPSocket.
34
37
*/
35
38
36
39
class DTLSSocket : public DTLSSocketWrapper {
Original file line number Diff line number Diff line change 28
28
#if defined(MBEDTLS_SSL_CLI_C) || defined(DOXYGEN_ONLY)
29
29
30
30
/* *
31
- * \brief DTLSSocketWrapper implement DTLS stream over the existing Socket transport
31
+ * \brief DTLSSocketWrapper implement DTLS stream over the existing Socket transport.
32
32
*/
33
33
class DTLSSocketWrapper : public TLSSocketWrapper {
34
34
public:
Original file line number Diff line number Diff line change 25
25
#include " netsocket/SocketAddress.h"
26
26
#include " Callback.h"
27
27
28
- /* * Abstract socket class
28
+ /* * Socket interface.
29
+ *
30
+ * This class defines the Mbed OS Socket API.
31
+ * Socket is an abstract interface for communicating to remote endpoints.
32
+ *
33
+ * This API is intented to use for applications and libraries instead of
34
+ * using some protocol specific implementation of it. For example TCPSocket
35
+ * and UDPSocket are implementations of Socket interface.
36
+ * Socket API is intentionally not protocol specific and allows all protocol
37
+ * to provide same API regardless of underlying transport mechanism.
29
38
*/
30
39
class Socket {
31
40
public:
Original file line number Diff line number Diff line change 36
36
37
37
/* *
38
38
* \brief TLSSocket a wrapper around TCPSocket for interacting with TLS servers.
39
+ *
40
+ * TLSSocket uses the TLSSocketWrapper with internal TCP socket. This is a
41
+ * easy to use helper for creating commonly used TLS connection over TCP.
42
+ *
39
43
*/
40
44
class TLSSocket : public TLSSocketWrapper {
41
45
public:
Original file line number Diff line number Diff line change 35
35
#if defined(MBEDTLS_SSL_CLI_C) || defined(DOXYGEN_ONLY)
36
36
37
37
/* *
38
- * \brief TLSSocket a wrapper around Socket for interacting with TLS servers
38
+ * TLSSocket a wrapper around Socket for interacting with TLS servers.
39
+ *
40
+ * TLSSocketWrapper can use any Socket as a transport and after
41
+ * completing the TLS handshake, can be used as any Socket would be used.
42
+ *
39
43
*/
40
44
class TLSSocketWrapper : public Socket {
41
45
public:
You can’t perform that action at this time.
0 commit comments