Skip to content

Commit 128203d

Browse files
committed
Add documentation for set_root_ca_cert overload
1 parent c3fff6e commit 128203d

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

connectivity/netsocket/include/netsocket/TLSSocketWrapper.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,9 @@ class TLSSocketWrapper : public Socket {
102102
* @retval NSAPI_ERROR_OK on success.
103103
* @retval NSAPI_ERROR_NO_MEMORY in case there is not enough memory to allocate certificate.
104104
* @retval NSAPI_ERROR_PARAMETER in case the provided root_ca parameter failed parsing.
105+
*
106+
* @note The user can also provide root_ca as a filesystem path (containing files in any Mbed TLS-supported format)
107+
* if len == 0 and MBEDTLS_FS_IO is defined
105108
*/
106109
nsapi_error_t set_root_ca_cert(const void *root_ca, size_t len);
107110

0 commit comments

Comments
 (0)