libsxmp/man/sxmp_init.3

55 lines
1.3 KiB
Groff
Raw Normal View History

2015-10-25 03:22:03 +02:00
.TH SXMP_INIT 3 "20 July 2015" "SXMPLv2" "SXMP Library Manual"
2015-07-26 05:21:18 +03:00
.SH NAME
2015-10-25 03:22:03 +02:00
sxmp_init \- Initialize all required globals to run sxmp library functions
2015-07-26 05:21:18 +03:00
.br
2015-10-25 03:22:03 +02:00
sxmp_finalize \- Destroy all allocated resources for SXMP operation
2015-08-05 11:38:44 +03:00
.br
2015-07-26 05:21:18 +03:00
.SH SYNOPSIS
2015-10-25 03:22:03 +02:00
.B #include <sxmp/sxmp.h>
2015-07-26 05:21:18 +03:00
.sp
2015-10-25 03:22:03 +02:00
int sxmp_init(void);
2015-07-26 05:21:18 +03:00
2015-10-25 03:22:03 +02:00
void sxmp_finalize(void);
2015-07-26 05:21:18 +03:00
.br
.sp
.SH DESCRIPTION
2015-10-25 03:22:03 +02:00
.B sxmp_init
will initialize all globals required to run sxmp related functions, it mostly about
2015-07-26 05:21:18 +03:00
openssl library initialization.
.br
2015-10-25 03:22:03 +02:00
.B sxmp_finalize
will destroy all resources allocated for SXMP library operation.
2015-07-26 05:21:18 +03:00
.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
2015-10-25 03:22:03 +02:00
Call this function from the main thread before using sxmp library. Otherwise it will not works. There are also
2015-07-26 05:21:18 +03:00
useful to know if you are using other openssl functionality there are no need to initialize globals for it.
2015-08-05 11:38:44 +03:00
.br
If you are using openssl, don't call
2015-10-25 03:22:03 +02:00
.B sxmp_finalize
2015-08-05 11:38:44 +03:00
until you will finish with them.
2015-07-26 05:21:18 +03:00
.SH RATIONALE
None.
.SH SEE ALSO
2015-10-25 03:22:03 +02:00
.BI sxhub_create(3)
2015-07-26 05:21:18 +03:00
,
2015-10-25 03:22:03 +02:00
.BI sxhub_destroy(3)
2015-07-26 05:21:18 +03:00
.SH COPYRIGHT
2015-12-29 22:42:52 +02:00
This software licensed under GNU LGPL v3. See COPYING for further details.
2015-07-26 05:21:18 +03:00
.br
(c) Askele Group 2013-2015 <http://askele.com>
.SH AUTHOR
Alexander Vdolainen (vdo@askele.com)