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
2.1 KiB
Groff
81 lines
2.1 KiB
Groff
.TH CONNECTIONS_CREATE 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
|
|
.SH NAME
|
|
connections_create \- Allocate and initialize connections system
|
|
.br
|
|
connections_init \- Initialize connections system
|
|
.br
|
|
connections_destroy \- Destroy connections system
|
|
.br
|
|
connections_free \- Free all stuff allocated for connections system
|
|
.SH SYNOPSIS
|
|
.B #include <sntl/sntllv2.h>
|
|
.sp
|
|
conn_sys_t *connections_create(void);
|
|
|
|
int connections_init(conn_sys_t *ssys);
|
|
|
|
int connections_destroy(conn_sys_t *ssys);
|
|
|
|
int connections_free(conn_sys_t *ssys);
|
|
|
|
.br
|
|
.sp
|
|
.SH DESCRIPTION
|
|
.B connections_create
|
|
will create a separate connections set used for handling creation and initialization of the connection links.
|
|
.B connections_init
|
|
will do the same, but it will take an already preallocated pointer.
|
|
.br
|
|
.B connections_destroy
|
|
will deallocate all related to the connections set, include pointer
|
|
.BI ssys
|
|
, but
|
|
.B connections_free
|
|
will not free this pointer consider it will be deallocated by user.
|
|
.br
|
|
.SH RETURN VALUE
|
|
Upon successful completion, the function
|
|
.B connections_create
|
|
will return a valid pointer to the connections set.
|
|
.B connections_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 connections_init
|
|
use.
|
|
.SH ERRORS
|
|
.B connections_init
|
|
will return,
|
|
.B connection_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
|
|
Connection link destroy function might be used carefully, the logic of there functions is a
|
|
send a special link layer message that will close the connection link on the master side.
|
|
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 connections_setsslserts(3)
|
|
,
|
|
.BI sntl_init(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)
|