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

manuals fixed;

Browse Source
This commit is contained in:
Alexander Vdolainen 2015-10-27 00:20:44 +02:00
parent 2f7d0e8045
commit e968375721
16 changed files with 109 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
man/sxchannel_open.3
View File

@ -1,10 +1,10 @@
.TH SXCHANNEL_OPEN 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXCHANNEL_OPEN 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
sxchannel_open \- Open RPC channel.
.br
sxchannel_close \- Close RPC channel
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.sp
chnl_t *sxchannel_open(conn_t *co, int type);
@ -62,7 +62,7 @@ None.
.SH RATIONALE
None.
.SH SEE ALSO
.BI connections_set_rpcvalidator(3)
.BI sxhub_set_rpcvalidator(3)
,
.BI connection_link(3)
,

42
man/sxhub_create.3
View File

@ -1,53 +1,53 @@
.TH CONNECTIONS_CREATE 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXHUB_CREATE 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
connections_create \- Allocate and initialize connections system
sxhub_create \- Allocate and initialize connections system
.br
connections_init \- Initialize connections system
sxhub_init \- Initialize connections system
.br
connections_destroy \- Destroy connections system
sxhub_destroy \- Destroy connections system
.br
connections_free \- Free all stuff allocated for connections system
sxhub_free \- Free all stuff allocated for connections system
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.sp
conn_sys_t *connections_create(void);
sxhub_t *sxhub_create(void);
int connections_init(conn_sys_t *ssys);
int sxhub_init(sxhub_t *ssys);
int connections_destroy(conn_sys_t *ssys);
int sxhub_destroy(sxhub_t *ssys);
int connections_free(conn_sys_t *ssys);
int sxhub_free(sxhub_t *ssys);
.br
.sp
.SH DESCRIPTION
.B connections_create
.B sxhub_create
will create a separate connections set used for handling creation and initialization of the connection links.
.B connections_init
.B sxhub_init
will do the same, but it will take an already preallocated pointer.
.br
.B connections_destroy
.B sxhub_destroy
will deallocate all related to the connections set, include pointer
.BI ssys
, but
.B connections_free
.B sxhub_free
will not free this pointer consider it will be deallocated by user.
.br
.SH RETURN VALUE
Upon successful completion, the function
.B connections_create
.B sxhub_create
will return a valid pointer to the connections set.
.B connections_init
.B sxhub_init
will return
.B 0
.br
Otherwise NULL will be returned and errno will be set, or error will be returned, in case of
.B connections_init
.B sxhub_init
use.
.SH ERRORS
.B connections_init
.B sxhub_init
will return,
.B connection_create will set
.B sxhub_create will set
.B errno
to:
.br
@ -69,9 +69,9 @@ send a special link layer message that will close the connection link on the mas
The reason to care about is a delivery of all messages, channels and other stuff, because
when this functions called all pending messages are drops.
.SH SEE ALSO
.BI connections_setsslserts(3)
.BI sxhub_setsslserts(3)
,
.BI sntl_init(3)
.BI sxmp_init(3)
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br

16
man/sxhub_set_authcheck.3
View File

@ -1,11 +1,11 @@
.TH CONNECTIONS_SET_AUTHCHECK 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXHUB_SET_AUTHCHECK 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
connections_set_authcheck \- Set callback for the connection links based on the connections set, called to validate user name and password of the peer.
sxhub_set_authcheck \- Set callback for the connection links based on the connections set, called to validate user name and password of the peer.
.br
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.sp
#define connections_set_authcheck(c, f)
#define sxhub_set_authcheck(c, f)
.br
.sp
@ -53,13 +53,13 @@ This function should be used on the master service, it will not be called on the
.SH RATIONALE
None.
.SH SEE ALSO
.BI connections_set_priv(3)
.BI sxhub_set_priv(3)
,
.BI connections_get_priv(3)
.BI sxhub_get_priv(3)
,
.BI connections_set_ondestroy(3)
.BI sxhub_set_ondestroy(3)
,
.BI connections_set_sslvalidate(3)
.BI sxhub_set_sslvalidate(3)
,
.BI connection_getpctx(3)
,

12
man/sxhub_set_channelcall.3
View File

@ -1,11 +1,11 @@
.TH CONNECTIONS_SET_CHANNELCALL 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXHUB_SET_CHANNELCALL 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
connections_set_channelcall \- Set callback for the connection links based on the connections set, called during connection link initiation on the client side.
sxhub_set_channelcall \- Set callback for the connection links based on the connections set, called during connection link initiation on the client side.
.br
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.sp
#define connections_set_channelcall(c, f)
#define sxhub_set_channelcall(c, f)
.br
.sp
@ -28,7 +28,7 @@ In fail case other code error should be returned. It's a good practice to return
.B SNE_IGNORED
if your application doesn't support protocol channels or outdated.
.br
SNTL will push channel type id in
SXMP will push channel type id in
.B tid
and text description in
.B desc
@ -56,7 +56,7 @@ This function should be used on the client service, it will not be called on the
.SH RATIONALE
None.
.SH SEE ALSO
.BI connections_set_ondestroy(3)
.BI sxhub_set_ondestroy(3)
,
.BI connection_getpriv(3)
,

14
man/sxhub_set_ondestroy.3
View File

@ -1,11 +1,11 @@
.TH CONNECTIONS_SET_ONDESTROY 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXHUB_SET_ONDESTROY 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
connections_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 connection links based on the connections set, called in case of link destroying
.br
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.sp
#define connections_set_ondestroy(c, f)
#define sxhub_set_ondestroy(c, f)
.br
.sp
@ -36,11 +36,11 @@ None.
.SH RATIONALE
None.
.SH SEE ALSO
.BI connections_set_priv(3)
.BI sxhub_set_priv(3)
,
.BI connections_get_priv(3)
.BI sxhub_get_priv(3)
,
.BI connections_set_onpulse(3)
.BI sxhub_set_onpulse(3)
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br

14
man/sxhub_set_onpulse.3
View File

@ -1,11 +1,11 @@
.TH CONNECTIONS_SET_ONPULSE 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXHUB_SET_ONPULSE 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
connections_set_onpulse \- Set callback for the connection links based on the connections set, called in case of link pulse message
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 <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.sp
#define connections_set_onpulse(c, f)
#define sxhub_set_onpulse(c, f)
.br
.sp
@ -36,11 +36,11 @@ None.
.SH RATIONALE
None.
.SH SEE ALSO
.BI connections_set_priv(3)
.BI sxhub_set_priv(3)
,
.BI connections_get_priv(3)
.BI sxhub_get_priv(3)
,
.BI connections_set_ondestroy(3)
.BI sxhub_set_ondestroy(3)
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br

22
man/sxhub_set_priv.3
View File

@ -1,15 +1,15 @@
.TH CONNECTIONS_SET_PRIV 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXHUB_SET_PRIV 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
connections_set_priv \- Set a private pointer to the connection links set
sxhub_set_priv \- Set a private pointer to the connection links set
.br
connections_get_priv \- Get a private pointer of the connection links set
sxhub_get_priv \- Get a private pointer of the connection links set
.br
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.sp
#define connections_set_priv(c, p)
#define sxhub_set_priv(c, p)
.br
#define connections_get_priv(c)
#define sxhub_get_priv(c)
.br
.sp
@ -20,22 +20,22 @@ Pointer is a
.B void*
i.e. it might be anything you pointed in the memory.
.br
.B connections_set_priv
.B sxhub_set_priv
will set a pointer
.B p
to connections set
.B c
.br
.B connections_get_priv
.B sxhub_get_priv
will return your pointer set to
.B c
connection set.
.br
.SH RETURN VALUE
None in case of
.B connections_set_priv
.B sxhub_set_priv
, a private pointer set in case of
.B connections_get_priv
.B sxhub_get_priv
.br
.SH ERRORS
None.
@ -49,7 +49,7 @@ None.
.SH RATIONALE
None.
.SH SEE ALSO
.BI connections_set_ondestroy(3)
.BI sxhub_set_ondestroy(3)
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br

26
man/sxhub_set_rpcvalidator.3
View File

@ -1,11 +1,11 @@
.TH CONNECTIONS_SET_RPCVALIDATOR 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXHUB_SET_RPCVALIDATOR 3 "20 July 2015" "SXMP" "SXMP 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.
sxhub_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 <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.sp
#define connections_set_rpcvalidator(c, f)
#define sxhub_set_rpcvalidator(c, f)
.br
.sp
@ -26,11 +26,11 @@ It will pass a pointer to the connection link initiating now. Link isn't set ful
a valid pointer to the
.B usrtc_t
structure, this structure must be created with
.B sntl_rpclist_init
.B sxmp_rpclist_init
,
.B sntl_rpclist_add
.B sxmp_rpclist_add
,
.B sntl_rpclist_add_function
.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.
@ -47,11 +47,11 @@ This function should be used on the master service only, the client isn't set an
.SH RATIONALE
None.
.SH SEE ALSO
.BI connections_set_priv(3)
.BI sxhub_set_priv(3)
,
.BI connections_get_priv(3)
.BI sxhub_get_priv(3)
,
.BI connections_set_sslvalidate(3)
.BI sxhub_set_sslvalidate(3)
,
.BI connection_getpctx(3)
,
@ -59,11 +59,11 @@ None.
,
.BI connection_setpriv(3)
,
.BI sntl_rpclist_init(3)
.BI sxmp_rpclist_init(3)
,
.BI sntl_rpclist_add(3)
.BI sxmp_rpclist_add(3)
,
.BI sntl_rpclist_add_function(3)
.BI sxmp_rpclist_add_function(3)
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br

14
man/sxhub_set_sslvalidate.3
View File

@ -1,11 +1,11 @@
.TH CONNECTIONS_SET_SSLVALIDATE 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXHUB_SET_SSLVALIDATE 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
connections_set_sslvalidate \- Set callback for the connection links based on the connections set, called to validate x.509 certificate of peer by serial number.
sxhub_set_sslvalidate \- Set callback for the connection links based on the connections set, called to validate x.509 certificate of peer by serial number.
.br
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.sp
#define connections_set_sslvalidate(c, f)
#define sxhub_set_sslvalidate(c, f)
.br
.sp
@ -50,11 +50,11 @@ This function should be used on the master service, currently it's not applicabl
.SH RATIONALE
None.
.SH SEE ALSO
.BI connections_set_priv(3)
.BI sxhub_set_priv(3)
,
.BI connections_get_priv(3)
.BI sxhub_get_priv(3)
,
.BI connections_set_ondestroy(3)
.BI sxhub_set_ondestroy(3)
,
.BI connection_getpctx(3)
,

12
man/sxhub_setsslserts.3
View File

@ -1,17 +1,17 @@
.TH CONNECTIONS_SETSSLSERTS 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXHUB_SETSSLSERTS 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
connections_setsslserts \- Setup root public certificate to check up, and also setups key and public certificate used for connections set
sxhub_setsslserts \- Setup root public certificate to check up, and also setups key and public certificate used for connections set
.br
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.sp
int connections_setsslserts(conn_sys_t *ssys, const char *rootca,
int sxhub_setsslserts(sxhub_t *ssys, const char *rootca,
const char *certpem, const char *certkey);
.br
.sp
.SH DESCRIPTION
.B connections_setsslserts
.B sxhub_setsslserts
will setup root public certificate and private key and public certificate used to run connections set.
This is required always, see below for more information.
.br
@ -41,7 +41,7 @@ Invalid pointer given.
There are no available memory for operation.
.br
.SH BUGS
None known yet, but name is historically wrong it should be called connections_setsslcerts, btw there are many
None known yet, but name is historically wrong it should be called sxhub_setsslcerts, btw there are many
code was written with this mistake.
.SH EXAMPLE
None.

16
man/sxlink_master_accept.3
View File

@ -1,4 +1,4 @@
.TH CONNECTION_MASTER_LINK 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH CONNECTION_MASTER_LINK 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
connection_master_link \- Create a connection on already accept TCP connection on the master side.
.br
@ -6,11 +6,11 @@ connection_link \- Create connection to the master.
.br
connection_close \- Close connection.
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.sp
conn_t *connection_master_link(conn_sys_t *ssys, int sck, struct in_addr *addr);
conn_t *connection_master_link(sxhub_t *ssys, int sck, struct in_addr *addr);
conn_t *connection_link(conn_sys_t *ssys, const char *host,
conn_t *connection_link(sxhub_t *ssys, const char *host,
int port, const char *SSL_cert, const char *login,
const char *passwd);
@ -86,13 +86,13 @@ None.
.SH RATIONALE
Using connection_link on master side with initialized connections set for master functionality will cause memory leaks, use different connections set structure if you need this functionality on the masters side.
.SH SEE ALSO
.BI connections_setsslserts(3)
.BI sxhub_setsslserts(3)
,
.BI connections_create(3)
.BI sxhub_create(3)
,
.BI connections_destroy(3)
.BI sxhub_destroy(3)
,
.BI sntl_init(3)
.BI sxmp_init(3)
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br

4
man/sxmsg_pulse.3
View File

@ -1,8 +1,8 @@
.TH SXMSG_PULSE 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXMSG_PULSE 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
sxmsg_pulse \- Function used to send a pulse
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.sp
int sxmsg_pulse(conn_t *co, const char *data, size_t datalen);
.sp

4
man/sxmsg_reply.3
View File

@ -1,10 +1,10 @@
.TH SXMSG_REPLY 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXMSG_REPLY 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
sxmsg_reply \- Reply to the message from the peer and wait while confirmation will be received.
.br
sxmsg_send_pp \- Reply to the message from the peer and wait while confirmation will be received in postponed message send mode.
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.br
.sp
int sxmsg_reply(sxmsg_t *msg, const char *data, size_t datalen);

4
man/sxmsg_return.3
View File

@ -1,10 +1,10 @@
.TH SXMSG_RETURN 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXMSG_RETURN 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
sxmsg_return \- Return a message with error and close dialog.
.br
sxmsg_return_pp \- Return a message with error and close dialog in postponed message send mode.
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.br
.sp
int sxmsg_return(sxmsg_t *msg, int opcode);

8
man/sxmsg_rreply.3
View File

@ -1,10 +1,10 @@
.TH SXMSG_RREPLY 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXMSG_RREPLY 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
sxmsg_rreply \- Function used to send a rapid reply without confirmation
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.br
.B #include <sntl/limits.h>
.B #include <sxmp/limits.h>
.sp
int sxmsg_rreply(sxmsg_t
.BI *msg
@ -50,7 +50,7 @@ return sxmsg_rreply(msg, str, ln);
.SH APPLICATION USAGE
This function will be useful in RPC functions required to reply ASAP i.e. for getting some data. If RPC function takes a lot of time it's better to use other functions and/or postponed message processing.
.SH RATIONALE
Use for lightweight RPC functions, this method can be used only in RPC call i.e. within SNTL thread context.
Use for lightweight RPC functions, this method can be used only in RPC call i.e. within SXMP thread context.
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br

4
man/sxmsg_send.3
View File

@ -1,10 +1,10 @@
.TH SXMSG_SEND 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXMSG_SEND 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
sxmsg_send \- Create and send a message within called thread context.
.br
sxmsg_send_pp \- Create and send a message in postponed mode.
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.br
.sp
int sxmsg_send(chnl_t *channel, const char *data, size_t datalen, sxmsg_t **msg);