added connections_set_ondestroy manpage;

v0.5.xx
Alexander Vdolainen 9 years ago
parent ff1aa8ff48
commit 7012a49fa3

@ -7,3 +7,4 @@ man/sntl_init.3
man/connections_setsslserts.3
man/connections_set_priv.3
man/connections_get_priv.3
man/connections_set_ondestroy.3

@ -1,2 +1,3 @@
man_MANS = sxmsg_rreply.3 connections_create.3 connections_init.3 connections_destroy.3 connections_free.3 \
sntl_init.3 connections_setsslserts.3 connections_set_priv.3 connections_get_priv.3
sntl_init.3 connections_setsslserts.3 connections_set_priv.3 connections_get_priv.3 \
connections_set_ondestroy.3

@ -0,0 +1,48 @@
.TH CONNECTIONS_ON_DESTROY 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.SH NAME
connections_on_destroy \- Set callback for the connection links based on the connections set, called in case of link destroying
.br
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.sp
#define connections_set_ondestroy(c, f)
.br
.sp
.SH DESCRIPTION
This macro should be used if you want to setup callback function fired upon a connection is closed or broken.
.br
This macro will set on
.B c
connections link set callback
.B f
which is a function pointer of the type:
.br
.sp
.B typedef void (*ondestroy_t)(conn_t *);
.br
.sp
This function will be called if connection link failed, broken etc. It will pass a pointer to the failed connection.
.SH RETURN VALUE
None.
.SH ERRORS
None.
.SH BUGS
None known yet.
.SH EXAMPLE
None.
.SH APPLICATION USAGE
None.
.SH RATIONALE
None.
.SH SEE ALSO
.BI connections_set_priv(3)
,
.BI connections_get_priv(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)
Loading…
Cancel
Save