Skip to content

Commit 13f8f66

Browse files
committed
Add docs
1 parent b32c1aa commit 13f8f66

1 file changed

Lines changed: 96 additions & 0 deletions

File tree

  • doc/dox_comments/header_files

doc/dox_comments/header_files/ssl.h

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15213,6 +15213,102 @@ int wolfSSL_set_client_cert_type(WOLFSSL* ssl, const char* buf, int len);
1521315213
*/
1521415214
int wolfSSL_set_server_cert_type(WOLFSSL* ssl, const char* buf, int len);
1521515215

15216+
/*!
15217+
\ingroup Setup
15218+
15219+
\brief Enables handshake message grouping for the given WOLFSSL_CTX context.
15220+
15221+
This function turns on handshake message grouping for all SSL objects created from the specified context.
15222+
15223+
\return WOLFSSL_SUCCESS on success.
15224+
\return BAD_FUNC_ARG if ctx is NULL.
15225+
15226+
\param ctx Pointer to the WOLFSSL_CTX structure.
15227+
15228+
_Example_
15229+
\code
15230+
WOLFSSL_CTX* ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
15231+
wolfSSL_CTX_set_group_messages(ctx);
15232+
\endcode
15233+
15234+
\sa wolfSSL_CTX_clear_group_messages
15235+
\sa wolfSSL_set_group_messages
15236+
\sa wolfSSL_clear_group_messages
15237+
*/
15238+
int wolfSSL_CTX_set_group_messages(WOLFSSL_CTX* ctx);
15239+
15240+
/*!
15241+
\ingroup Setup
15242+
15243+
\brief Disables handshake message grouping for the given WOLFSSL_CTX context.
15244+
15245+
This function turns off handshake message grouping for all SSL objects created from the specified context.
15246+
15247+
\return WOLFSSL_SUCCESS on success.
15248+
\return BAD_FUNC_ARG if ctx is NULL.
15249+
15250+
\param ctx Pointer to the WOLFSSL_CTX structure.
15251+
15252+
_Example_
15253+
\code
15254+
WOLFSSL_CTX* ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
15255+
wolfSSL_CTX_clear_group_messages(ctx);
15256+
\endcode
15257+
15258+
\sa wolfSSL_CTX_set_group_messages
15259+
\sa wolfSSL_set_group_messages
15260+
\sa wolfSSL_clear_group_messages
15261+
*/
15262+
int wolfSSL_CTX_clear_group_messages(WOLFSSL_CTX* ctx);
15263+
15264+
/*!
15265+
\ingroup Setup
15266+
15267+
\brief Enables handshake message grouping for the given WOLFSSL object.
15268+
15269+
This function turns on handshake message grouping for the specified SSL object.
15270+
15271+
\return WOLFSSL_SUCCESS on success.
15272+
\return BAD_FUNC_ARG if ssl is NULL.
15273+
15274+
\param ssl Pointer to the WOLFSSL structure.
15275+
15276+
_Example_
15277+
\code
15278+
WOLFSSL* ssl = wolfSSL_new(ctx);
15279+
wolfSSL_set_group_messages(ssl);
15280+
\endcode
15281+
15282+
\sa wolfSSL_clear_group_messages
15283+
\sa wolfSSL_CTX_set_group_messages
15284+
\sa wolfSSL_CTX_clear_group_messages
15285+
*/
15286+
int wolfSSL_set_group_messages(WOLFSSL* ssl);
15287+
15288+
/*!
15289+
\ingroup Setup
15290+
15291+
\brief Disables handshake message grouping for the given WOLFSSL object.
15292+
15293+
This function turns off handshake message grouping for the specified SSL object.
15294+
15295+
\return WOLFSSL_SUCCESS on success.
15296+
\return BAD_FUNC_ARG if ssl is NULL.
15297+
15298+
\param ssl Pointer to the WOLFSSL structure.
15299+
15300+
_Example_
15301+
\code
15302+
WOLFSSL* ssl = wolfSSL_new(ctx);
15303+
wolfSSL_clear_group_messages(ssl);
15304+
\endcode
15305+
15306+
\sa wolfSSL_set_group_messages
15307+
\sa wolfSSL_CTX_set_group_messages
15308+
\sa wolfSSL_CTX_clear_group_messages
15309+
*/
15310+
int wolfSSL_clear_group_messages(WOLFSSL* ssl);
15311+
1521615312
/*!
1521715313
\ingroup SSL
1521815314
\brief This function returns the result of the client certificate type

0 commit comments

Comments
 (0)