From 960414e7a9a1d8a5a6addf0b740d77b2edbab20a Mon Sep 17 00:00:00 2001 From: Alexander Vdolainen Date: Thu, 23 Jul 2015 14:53:47 +0300 Subject: [PATCH] updated man; --- man/sxmsg_rreply.3SNTL | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/man/sxmsg_rreply.3SNTL b/man/sxmsg_rreply.3SNTL index ad32902..aebbc4f 100644 --- a/man/sxmsg_rreply.3SNTL +++ b/man/sxmsg_rreply.3SNTL @@ -4,16 +4,28 @@ sxmsg_rreply \- Function used to send a rapid reply without confirmation .SH SYNOPSIS .B #include .sp -.BI int sxmsg_rreply(sxmsg_t *msg, size_t datalen); +int sxmsg_rreply(sxmsg_t +.BI *msg +, size_t +.BI datalen +); .br .sp .SH DESCRIPTION .B sxmsg_rreply -Will reply rapidly to the message using already allocated buffer, which might be -retrieved via sxmsg_rapidbuf(). This function will write desired message as soon -as possible. It will not wait any write or delivery confirmation. +Will reply rapidly to the message using already allocated buffer, which must be +retrieved via +.B sxmsg_rapidbuf(). +This function will write desired message as soon +as possible. It will not wait any write or delivery confirmation. It will close +message dialog if message is valid. .br .SH RETURN VALUE +Upon successful completion, the function shall rapidly send a message reply and close +the message dialog 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 @@ -33,3 +45,13 @@ Not known yet. char *buf = sxmsg_rapidbuf(msg); int ln = snprintf(buf, MAX_BBUFLEN, "(is-done)"); 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. It RPC function takes a lot of time it's better to use other functions and postponed message processing. +.SH RATIONALE +Use for lightweight RPC functions, this method may be used only in RPC call i.e. within SNTL thread context. +.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)