From 7012a49fa3228753ebf094360a1ec971a42621f4 Mon Sep 17 00:00:00 2001 From: Alexander Vdolainen Date: Sun, 26 Jul 2015 06:20:46 +0300 Subject: [PATCH] added connections_set_ondestroy manpage; --- debian/libsntl-dev.manpages | 3 ++- man/Makefile.am | 3 ++- man/connections_set_ondestroy.3 | 48 +++++++++++++++++++++++++++++++++ 3 files changed, 52 insertions(+), 2 deletions(-) create mode 100644 man/connections_set_ondestroy.3 diff --git a/debian/libsntl-dev.manpages b/debian/libsntl-dev.manpages index bc7f8c1..a09594c 100644 --- a/debian/libsntl-dev.manpages +++ b/debian/libsntl-dev.manpages @@ -6,4 +6,5 @@ man/connections_init.3 man/sntl_init.3 man/connections_setsslserts.3 man/connections_set_priv.3 -man/connections_get_priv.3 \ No newline at end of file +man/connections_get_priv.3 +man/connections_set_ondestroy.3 \ No newline at end of file diff --git a/man/Makefile.am b/man/Makefile.am index 21a3388..8075986 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -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 diff --git a/man/connections_set_ondestroy.3 b/man/connections_set_ondestroy.3 new file mode 100644 index 0000000..7518364 --- /dev/null +++ b/man/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 +.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 +.SH AUTHOR +Alexander Vdolainen (vdo@askele.com) +