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

man: added sxmsg_pulse.3 manpage;

Browse Source
This commit is contained in:
Alexander Vdolainen 2015-08-05 11:39:14 +03:00
parent eae148b2fe
commit 61a2dd1e9f
2 changed files with 48 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
man/Makefile.am
View File

@ -3,4 +3,4 @@ man_MANS = sxmsg_rreply.3 connections_create.3 connections_init.3 connections_de
connections_set_ondestroy.3 connections_set_onpulse.3 connections_set_sslvalidate.3 \
connections_set_authcheck.3 connections_set_rpcvalidator.3 connections_set_channelcall.3 \
connection_master_link.3 connection_link.3 connection_close.3 sxchannel_open.3 \
sxchannel_close.3 sxmsg_send.3 sxmsg_send_pp.3 sxmsg_clean.3
sxchannel_close.3 sxmsg_send.3 sxmsg_send_pp.3 sxmsg_clean.3 sntl_finalize.3 sxmsg_pulse.3

47
man/sxmsg_pulse.3 Normal file
View File

@ -0,0 +1,47 @@
.TH SXMSG_PULSE 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.SH NAME
sxmsg_pulse \- Function used to send a pulse
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.sp
int sxmsg_pulse(conn_t *co, const char *data, size_t datalen);
.sp
.SH DESCRIPTION
.B sxmsg_pulse
Will send a pulse message to the peer of underlying connection link
.B co
with given buffer
.B data
with given length in bytes
.B datalen.
.br
.SH RETURN VALUE
Upon successful completion, the function will write a pulse message returning
.B SNE_SUCCESS
Othrewise other error code will be returned.
.SH ERRORS
.B SNE_FAILED
returns if message has invalid index, channel or message pointer is NULL.
.br
.B SNE_ESSL
returns if write was failed i.e. connection link was broken, or SSL error occurs.
.br
.B SNE_EBUSY
Limit exceed.
.B SNE_SUCCESS
returns on success.
.br
.SH BUGS
Not known yet.
.SH EXAMPLE
None.
.SH APPLICATION USAGE
This function might be useful to send events to the peer.
.SH RATIONALE
Calling this function from the client might blocks all operation with callee.
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br
(c) Askele Group 2013-2015 <http://askele.com>
.SH AUTHOR
Alexander Vdolainen (vdo@askele.com)