[manpages] Added sxlink_connect_at function to manpages;

This commit is contained in:
Alexander Vdolainen 2016-03-15 13:17:44 +02:00
parent f25b8509b7
commit b6e1814d80
3 changed files with 18 additions and 4 deletions

View File

@ -4,4 +4,4 @@ man_MANS = sxmsg_rreply.3 sxhub_create.3 sxhub_init.3 sxhub_destroy.3 sxhub_free
sxhub_set_authcheck.3 sxhub_set_rpcvalidator.3 sxhub_set_channelcall.3 \ sxhub_set_authcheck.3 sxhub_set_rpcvalidator.3 sxhub_set_channelcall.3 \
sxlink_master_accept.3 sxlink_connect.3 sxlink_close.3 sxchannel_open.3 \ sxlink_master_accept.3 sxlink_connect.3 sxlink_close.3 sxchannel_open.3 \
sxchannel_close.3 sxmsg_send.3 sxmsg_send_pp.3 sxmsg_clean.3 sxmp_finalize.3 sxmsg_pulse.3 \ sxchannel_close.3 sxmsg_send.3 sxmsg_send_pp.3 sxmsg_clean.3 sxmp_finalize.3 sxmsg_pulse.3 \
sxmsg_reply.3 sxmsg_reply_pp.3 sxmsg_return.3 sxmsg_return_pp.3 sxmsg_reply.3 sxmsg_reply_pp.3 sxmsg_return.3 sxmsg_return_pp.3 sxlink_connect_at.3

1
man/sxlink_connect_at.3 Symbolic link
View File

@ -0,0 +1 @@
sxlink_master_accept.3

View File

@ -1,9 +1,11 @@
.TH SXLINK_MASTER_ACCEPT 3 "20 July 2015" "SXMP" "SXMP Library Manual" .TH SXLINK_MASTER_ACCEPT 3 "15 March 2016" "SXMP" "SXMP Library Manual"
.SH NAME .SH NAME
sxlink_master_accept \- Create a new link on already accept TCP connection on the master side. sxlink_master_accept \- Create a new link on already accept TCP connection on the master side.
.br .br
sxlink_connect \- Create link to the master. sxlink_connect \- Create link to the master.
.br .br
sxlink_connect_at \- Create link to the master and assign private data.
.br
sxlink_close \- Close link. sxlink_close \- Close link.
.SH SYNOPSIS .SH SYNOPSIS
.B #include <sxmp/sxmp.h> .B #include <sxmp/sxmp.h>
@ -14,6 +16,10 @@ sxlink_t *sxlink_connect(sxhub_t *hub, const char *host,
int port, const char *SSL_cert, const char *login, int port, const char *SSL_cert, const char *login,
const char *passwd); const char *passwd);
sxlink_t *sxlink_connect_at(sxhub_t *hub, const char *host,
int port, const char *SSL_cert, const char *login,
const char *passwd, const void *priv);
int sxlink_close(sxlink_t *co); int sxlink_close(sxlink_t *co);
.br .br
@ -44,6 +50,13 @@ trying to authorizated with username pointed by
and password pointed by and password pointed by
.B passwd .B passwd
.br .br
.B sxlink_connect_at
will do the same as
.B sxlink_connect
but also will assign a private data pointed by
.B priv
to be used by application implementation.
.br
.B sxlink_close .B sxlink_close
will close link pointed by will close link pointed by
.B co .B co
@ -96,6 +109,6 @@ Using connection_link on master side with initialized connections set for master
.SH COPYRIGHT .SH COPYRIGHT
This software licensed under GNU LGPL v3. See COPYING for further details. This software licensed under GNU LGPL v3. See COPYING for further details.
.br .br
(c) Askele Group 2013-2015 <http://askele.com> (c) Askele Group 2013-2015 <http://askele.com>, (c) libsxmp dev team 2016 <http://libsxmp.sf.net>
.SH AUTHOR .SH AUTHOR
Alexander Vdolainen (vdo@askele.com) Alexander Vdolainen (avdolainen@zoho.com)