public/libsxmp
public/libsxmp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fixed manpages;

Browse Source
This commit is contained in:
Alexander Vdolainen 2015-11-11 16:01:18 +02:00
parent e38ea0727b
commit 5fbee7e086
4 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
man/sxchannel_open.3
View File

@ -6,7 +6,7 @@ sxchannel_close \- Close RPC channel
.SH SYNOPSIS
.B #include <sxmp/sxmp.h>
.sp
chnl_t *sxchannel_open(sxlink_t *co, int type);
sxchnl_t *sxchannel_open(sxlink_t *co, int type);
int sxchannel_close(sxchnl_t *channel);

18
man/sxhub_set_authcheck.3
View File

@ -19,13 +19,13 @@ connections link set callback
which is a function pointer of the type:
.br
.sp
.B typedef int (*authcheck_t)(conn_t *);
.B typedef int (*authcheck_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
.B SNE_SUCCESS.
.B SXE_SUCCESS.
In fail case other code error should be returned. It's a good practice to return
.B SNE_EPERM
.B SXE_EPERM
if username and password mismatch.
.SH RETURN VALUE
None.
@ -38,15 +38,15 @@ This example shows the code prototype for the simple username and password check
.RS
.nf
.if t .ft CW
int logincheck(conn_t *co)
int logincheck(sxlink_t *co)
{
perm_ctx_t *ctx = connection_getpctx(co);
sxsession_ctx_t *ctx = sxlink_getpctx(co);
char *login = ctx->login;
char *password = ctx->password;
/* do checks ... */
/* your fail case */return SNE_EPERM;
return SNE_SUCCESS; /* all is fine */
return SXE_SUCCESS; /* all is fine */
}
.SH APPLICATION USAGE
This function should be used on the master service, it will not be called on the client application anyway.
@ -61,11 +61,11 @@ None.
,
.BI sxhub_set_sslvalidate(3)
,
.BI connection_getpctx(3)
.BI sxlink_getpctx(3)
,
.BI connection_getpriv(3)
.BI sxlink_getpriv(3)
,
.BI connection_setpriv(3)
.BI sxlink_setpriv(3)
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br

14
man/sxhub_set_channelcall.3
View File

@ -19,13 +19,13 @@ connections link set callback
which is a function pointer of the type:
.br
.sp
.B typedef int (*channelcall_t)(conn_t *co, int tid, char *desc);
.B typedef int (*channelcall_t)(sxlink_t *co, int tid, char *desc);
.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
.B SNE_SUCCESS.
.B SXE_SUCCESS.
In fail case other code error should be returned. It's a good practice to return
.B SNE_IGNORED
.B SXE_IGNORED
if your application doesn't support protocol channels or outdated.
.br
SXMP will push channel type id in
@ -45,11 +45,11 @@ This example shows the code prototype of such function:
.RS
.nf
.if t .ft CW
int rpcchanack(conn_t *co, int tid, char *desc)
int rpcchanack(sxlink_t *co, int tid, char *desc)
{
fprintf(stdout, "Master side supported RPC channel type: %d '%s'\n", tid, desc);
return SNE_SUCCESS; /* all is fine */
return SXE_SUCCESS; /* all is fine */
}
.SH APPLICATION USAGE
This function should be used on the client service, it will not be called on the master side anyway, since master provide RPC channels.
@ -58,9 +58,9 @@ None.
.SH SEE ALSO
.BI sxhub_set_ondestroy(3)
,
.BI connection_getpriv(3)
.BI sxlink_getpriv(3)
,
.BI connection_setpriv(3)
.BI sxlink_setpriv(3)
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br

8
man/sxhub_set_ondestroy.3
View File

@ -1,6 +1,6 @@
.TH SXHUB_SET_ONDESTROY 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
sxhub_set_ondestroy \- Set callback for the connection links based on the connections set, called in case of link destroying
sxhub_set_ondestroy \- Set callback for the links resides within hub, called in case of link destroying
.br
.SH SYNOPSIS
.B #include <sxmp/sxmp.h>
@ -14,15 +14,15 @@ This macro should be used if you want to setup callback function fired upon a co
.br
This macro will set on
.B c
connections link set callback
hub link set callback
.B f
which is a function pointer of the type:
.br
.sp
.B typedef void (*ondestroy_t)(conn_t *);
.B typedef void (*ondestroy_t)(sxlink_t *);
.br
.sp
This function will be called if connection link failed, broken etc. It will pass a pointer to the failed connection.
This function will be called if connection link failed, broken etc. It will pass a pointer to the failed link.
.SH RETURN VALUE
None.
.SH ERRORS