2015-10-27 00:20:44 +02:00
.TH SXHUB_SET_ONPULSE 3 "20 July 2015" "SXMP" "SXMP Library Manual"
2015-08-04 17:30:27 +03:00
.SH NAME
2015-10-27 00:20:44 +02:00
sxhub_set_onpulse \- Set callback for the connection links based on the connections set, called in case of link pulse message
2015-08-04 17:30:27 +03:00
.br
.SH SYNOPSIS
2015-10-27 00:20:44 +02:00
.B #include <sxmp/sxmp.h>
2015-08-04 17:30:27 +03:00
.sp
2015-10-27 00:20:44 +02:00
#define sxhub_set_onpulse(c, f)
2015-08-04 17:30:27 +03:00
.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
2015-11-13 14:16:08 +02:00
hub links set callback
2015-08-04 17:30:27 +03:00
.B f
which is a function pointer of the type:
.br
.sp
2015-11-13 14:16:08 +02:00
.B typedef void (*onpulse_t)(sxlink_t *, sexp_t *);
2015-08-04 17:30:27 +03:00
.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
2015-10-27 00:20:44 +02:00
.BI sxhub_set_priv(3)
2015-08-04 17:30:27 +03:00
,
2015-10-27 00:20:44 +02:00
.BI sxhub_get_priv(3)
2015-08-04 17:30:27 +03:00
,
2015-10-27 00:20:44 +02:00
.BI sxhub_set_ondestroy(3)
2015-08-04 17:30:27 +03:00
.SH COPYRIGHT
2015-12-29 22:42:52 +02:00
This software licensed under GNU LGPL v3. See COPYING for further details.
2015-08-04 17:30:27 +03:00
.br
(c) Askele Group 2013-2015 <http://askele.com>
.SH AUTHOR
Alexander Vdolainen (vdo@askele.com)
