From 88fca558016564b65036476f970a7dfc99c33a51 Mon Sep 17 00:00:00 2001 From: Alexander Vdolainen Date: Tue, 4 Aug 2015 17:30:27 +0300 Subject: [PATCH] added man for connections_set_onpulse; --- man/connections_set_onpulse.3 | 49 +++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 man/connections_set_onpulse.3 diff --git a/man/connections_set_onpulse.3 b/man/connections_set_onpulse.3 new file mode 100644 index 0000000..1111172 --- /dev/null +++ b/man/connections_set_onpulse.3 @@ -0,0 +1,49 @@ +.TH CONNECTIONS_SET_ONPULSE 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 pulse message +.br +.SH SYNOPSIS +.B #include +.sp +#define connections_set_onpulse(c, f) + +.br +.sp +.SH DESCRIPTION +This macro should be used if you want to setup callback function fired while pulse link message came. +.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 (*onpulse_t)(conn_t *, sexp_t *); +.br +.sp +This function will be called if connection link will receive pulse message. It will pass a pointer to the connection where pulse message came and prepared S expression. Please note, prepared S expression structure will be destroyed after a function call. +.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) +, +.BI connections_set_onpulse(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)