Skip to content

Commit cf1f6ad

Browse files
committed
Docs: add documentation to BIO funcs
1 parent 84db2a8 commit cf1f6ad

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

  • doc/dox_comments/header_files

doc/dox_comments/header_files/ssl.h

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4496,6 +4496,53 @@ WOLFSSL_METHOD* wolfSSLv23_client_method(void);
44964496
*/
44974497
int wolfSSL_BIO_get_mem_data(WOLFSSL_BIO* bio,void* p);
44984498

4499+
/*!
4500+
\ingroup IO
4501+
4502+
\brief This is used to set the init flag of a BIO, indicating whether
4503+
the BIO has been initialised and is ready for use. Typically called
4504+
from a custom BIO create callback.
4505+
4506+
\param bio WOLFSSL_BIO structure to set the init flag on.
4507+
\param init value to set (0 = not initialised, 1 = initialised).
4508+
4509+
_Example_
4510+
\code
4511+
WOLFSSL_BIO* bio;
4512+
// inside a custom BIO create callback
4513+
wolfSSL_BIO_set_init(bio, 1);
4514+
\endcode
4515+
4516+
\sa wolfSSL_BIO_get_init
4517+
\sa wolfSSL_BIO_new
4518+
*/
4519+
void wolfSSL_BIO_set_init(WOLFSSL_BIO* bio, int init);
4520+
4521+
/*!
4522+
\ingroup IO
4523+
4524+
\brief This is used to retrieve the init flag of a BIO, indicating
4525+
whether the BIO has been initialised and is ready for use.
4526+
4527+
\return 1 if the BIO has been initialised.
4528+
\return 0 if the BIO has not been initialised or bio is NULL.
4529+
4530+
\param bio WOLFSSL_BIO structure to query.
4531+
4532+
_Example_
4533+
\code
4534+
WOLFSSL_BIO* bio;
4535+
// create bio with custom method
4536+
if (wolfSSL_BIO_get_init(bio)) {
4537+
// bio is ready
4538+
}
4539+
\endcode
4540+
4541+
\sa wolfSSL_BIO_set_init
4542+
\sa wolfSSL_BIO_new
4543+
*/
4544+
int wolfSSL_BIO_get_init(WOLFSSL_BIO* bio);
4545+
44994546
/*!
45004547
\ingroup IO
45014548

0 commit comments

Comments
 (0)