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.
81 lines
1.9 KiB
Groff
81 lines
1.9 KiB
Groff
.TH SXHUB_CREATE 3 "20 July 2015" "SXMP" "SXMP Library Manual"
|
|
.SH NAME
|
|
sxhub_create \- Allocate and initialize links hub
|
|
.br
|
|
sxhub_init \- Initialize links hub
|
|
.br
|
|
sxhub_destroy \- Destroy links hub
|
|
.br
|
|
sxhub_free \- Free all stuff allocated for hub
|
|
.SH SYNOPSIS
|
|
.B #include <sxmp/sxmp.h>
|
|
.sp
|
|
sxhub_t *sxhub_create(void);
|
|
|
|
int sxhub_init(sxhub_t *ssys);
|
|
|
|
int sxhub_destroy(sxhub_t *ssys);
|
|
|
|
int sxhub_free(sxhub_t *ssys);
|
|
|
|
.br
|
|
.sp
|
|
.SH DESCRIPTION
|
|
.B sxhub_create
|
|
will create a new hub used for handling creation and initialization of the links.
|
|
.B sxhub_init
|
|
will do the same, but it will take an already preallocated pointer.
|
|
.br
|
|
.B sxhub_destroy
|
|
will deallocate all related to the hub, include pointer
|
|
.BI ssys
|
|
, but
|
|
.B sxhub_free
|
|
will not free this pointer consider it will be deallocated by user.
|
|
.br
|
|
.SH RETURN VALUE
|
|
Upon successful completion, the function
|
|
.B sxhub_create
|
|
will return a valid pointer to the newly created links hub.
|
|
.B sxhub_init
|
|
will return
|
|
.B 0
|
|
.br
|
|
Otherwise NULL will be returned and errno will be set, or error will be returned, in case of
|
|
.B sxhub_init
|
|
use.
|
|
.SH ERRORS
|
|
.B sxhub_init
|
|
will return,
|
|
.B sxhub_create will set
|
|
.B errno
|
|
to:
|
|
.br
|
|
.B ENOMEM
|
|
Not enough memory to allocate all required stuff.
|
|
.br
|
|
.B EINVAL
|
|
Returned if invalid pointer given.
|
|
.br
|
|
.SH BUGS
|
|
Not known yet.
|
|
.SH EXAMPLE
|
|
None.
|
|
.SH APPLICATION USAGE
|
|
None.
|
|
.SH RATIONALE
|
|
Link destroy function might be used carefully, the logic of there functions is a
|
|
send a special link layer message that will close the link on the master side (and within masters hub).
|
|
The reason to care about is a delivery of all messages, channels and other stuff, because
|
|
when this functions called all pending messages are drops.
|
|
.SH SEE ALSO
|
|
.BI sxhub_setsslserts(3)
|
|
,
|
|
.BI sxmp_init(3)
|
|
.SH COPYRIGHT
|
|
This software licensed under GNU LGPL v3. See COPYING for further details.
|
|
.br
|
|
(c) Askele Group 2013-2015 <http://askele.com>
|
|
.SH AUTHOR
|
|
Alexander Vdolainen (vdo@askele.com)
|