libsxmp/man/sxhub_set_rpcvalidator.3

73 lines
1.8 KiB
Groff
Raw Normal View History

2015-10-27 00:20:44 +02:00
.TH SXHUB_SET_RPCVALIDATOR 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
2015-11-13 14:16:08 +02:00
sxhub_set_rpcvalidator \- Set callback for the links created on the hub, called to validate and setup RPC channels.
.br
.SH SYNOPSIS
2015-10-27 00:20:44 +02:00
.B #include <sxmp/sxmp.h>
.sp
2015-10-27 00:20:44 +02:00
#define sxhub_set_rpcvalidator(c, f)
.br
.sp
.SH DESCRIPTION
2015-11-13 14:16:08 +02:00
This macro should be used if you want to setup callback function fired while link initiating, this call shouldn't be ignored since it setups the RPC channels tree structure used within the connection link.
.br
This macro will set on
.B c
connections link set callback
.B f
which is a function pointer of the type:
.br
.sp
2015-11-13 14:16:08 +02:00
.B typedef usrtc_t* (*rpcvalidate_t)(sxlink_t *);
.br
.sp
It will pass a pointer to the connection link initiating now. Link isn't set fully at this moment and doesn't pass any messages and don't works with channel's operations. To pass initiation to the next stage this function should return
a valid pointer to the
.B usrtc_t
structure, this structure must be created with
2015-10-27 00:20:44 +02:00
.B sxmp_rpclist_init
,
2015-10-27 00:20:44 +02:00
.B sxmp_rpclist_add
,
2015-10-27 00:20:44 +02:00
.B sxmp_rpclist_add_function
series functions.
.br
The returned value will be not handled by library and you should care about freeing it in your application.
.SH RETURN VALUE
None.
.SH ERRORS
None.
.SH BUGS
None known yet.
.SH EXAMPLE
None.
.SH APPLICATION USAGE
This function should be used on the master service only, the client isn't set any RPC channels yet.
.SH RATIONALE
None.
.SH SEE ALSO
2015-10-27 00:20:44 +02:00
.BI sxhub_set_priv(3)
,
2015-10-27 00:20:44 +02:00
.BI sxhub_get_priv(3)
,
2015-10-27 00:20:44 +02:00
.BI sxhub_set_sslvalidate(3)
,
2015-11-13 14:16:08 +02:00
.BI sxlink_getpctx(3)
,
2015-11-13 14:16:08 +02:00
.BI sxlink_getpriv(3)
,
2015-11-13 14:16:08 +02:00
.BI sxlink_setpriv(3)
,
2015-10-27 00:20:44 +02:00
.BI sxmp_rpclist_init(3)
,
2015-10-27 00:20:44 +02:00
.BI sxmp_rpclist_add(3)
,
2015-10-27 00:20:44 +02:00
.BI sxmp_rpclist_add_function(3)
.SH COPYRIGHT
2015-12-29 22:42:52 +02:00
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)