From 61a2dd1e9fbfb67e251dc04c7ab6d45867ccfe0f Mon Sep 17 00:00:00 2001 From: Alexander Vdolainen Date: Wed, 5 Aug 2015 11:39:14 +0300 Subject: [PATCH] man: added sxmsg_pulse.3 manpage; --- man/Makefile.am | 2 +- man/sxmsg_pulse.3 | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 man/sxmsg_pulse.3 diff --git a/man/Makefile.am b/man/Makefile.am index 226a414..6ef068d 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -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 diff --git a/man/sxmsg_pulse.3 b/man/sxmsg_pulse.3 new file mode 100644 index 0000000..c19d31f --- /dev/null +++ b/man/sxmsg_pulse.3 @@ -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 +.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 +.SH AUTHOR +Alexander Vdolainen (vdo@askele.com)