You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
libsxmp/man/sntl_init.3

55 lines
1.3 KiB
Groff

.TH SNTL_INIT 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.SH NAME
sntl_init \- Initialize all required globals to run sntl library functions
.br
sntl_finalize \- Destroy all allocated resources for SNTL operation
.br
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.sp
int sntl_init(void);
void sntl_finalize(void);
.br
.sp
.SH DESCRIPTION
.B sntl_init
will initialize all globals required to run sntl related functions, it mostly about
openssl library initialization.
.br
.B sntl_finalize
will destroy all resources allocated for SNTL library operation.
.SH RETURN VALUE
Always returns
.B 0
since we cannot track openssl global initialization routines.
.br
.SH ERRORS
None errors might be returned.
.SH BUGS
None known yet.
.SH EXAMPLE
None.
.SH APPLICATION USAGE
Call this function from the main thread before using sntl library. Otherwise it will not works. There are also
useful to know if you are using other openssl functionality there are no need to initialize globals for it.
.br
If you are using openssl, don't call
.B sntl_finalize
until you will finish with them.
.SH RATIONALE
None.
.SH SEE ALSO
.BI connections_create(3)
,
.BI connections_destroy(3)
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br
(c) Askele Group 2013-2015 <http://askele.com>
.SH AUTHOR
Alexander Vdolainen (vdo@askele.com)