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.
50 lines
1.2 KiB
Groff
50 lines
1.2 KiB
Groff
.TH SXHUB_SET_ONPULSE 3 "20 July 2015" "SXMP" "SXMP Library Manual"
|
|
.SH NAME
|
|
sxhub_set_onpulse \- Set callback for the connection links based on the connections set, called in case of link pulse message
|
|
.br
|
|
.SH SYNOPSIS
|
|
.B #include <sxmp/sxmp.h>
|
|
.sp
|
|
#define sxhub_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
|
|
hub links set callback
|
|
.B f
|
|
which is a function pointer of the type:
|
|
.br
|
|
.sp
|
|
.B typedef void (*onpulse_t)(sxlink_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 sxhub_set_priv(3)
|
|
,
|
|
.BI sxhub_get_priv(3)
|
|
,
|
|
.BI sxhub_set_ondestroy(3)
|
|
.SH COPYRIGHT
|
|
This software licensed under GNU LGPL v3. See COPYING for further details.
|
|
.br
|
|
(c) Askele Group 2013-2015 <http://askele.com>
|
|
.SH AUTHOR
|
|
Alexander Vdolainen (vdo@askele.com)
|