From b5e1ea4c6efedb226d3db40e7e4b4d5d1fb07ca3 Mon Sep 17 00:00:00 2001 From: Alexander Vdolainen Date: Tue, 4 Aug 2015 19:24:20 +0300 Subject: [PATCH] man: added connections_set_rpcvalidator.3 manpage; --- man/Makefile.am | 2 +- man/connections_set_rpcvalidator.3 | 72 ++++++++++++++++++++++++++++++ 2 files changed, 73 insertions(+), 1 deletion(-) create mode 100644 man/connections_set_rpcvalidator.3 diff --git a/man/Makefile.am b/man/Makefile.am index ac24965..337116b 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1,4 +1,4 @@ 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 \ connections_set_ondestroy.3 connections_set_onpulse.3 connections_set_sslvalidate.3 \ - connections_set_authcheck.3 + connections_set_authcheck.3 connections_set_rpcvalidator.3 diff --git a/man/connections_set_rpcvalidator.3 b/man/connections_set_rpcvalidator.3 new file mode 100644 index 0000000..4ed4523 --- /dev/null +++ b/man/connections_set_rpcvalidator.3 @@ -0,0 +1,72 @@ +.TH CONNECTIONS_SET_RPCVALIDATOR 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual" +.SH NAME +connections_set_rpcvalidator \- Set callback for the connection links based on the connections set, called to validate and setup RPC channels. +.br +.SH SYNOPSIS +.B #include +.sp +#define connections_set_rpcvalidator(c, f) + +.br +.sp +.SH DESCRIPTION +This macro should be used if you want to setup callback function fired while connection 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 +.B typedef usrtc_t* (*rpcvalidate_t)(conn_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 +.B sntl_rpclist_init +, +.B sntl_rpclist_add +, +.B sntl_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 +.BI connections_set_priv(3) +, +.BI connections_get_priv(3) +, +.BI connections_set_sslvalidate(3) +, +.BI connection_getpctx(3) +, +.BI connection_getpriv(3) +, +.BI connection_setpriv(3) +, +.BI sntl_rpclist_init(3) +, +.BI sntl_rpclist_add(3) +, +.BI sntl_rpclist_add_function(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)