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

updated man;

Browse Source
This commit is contained in:
Alexander Vdolainen 2015-07-23 14:53:47 +03:00
parent 928c48f20c
commit 960414e7a9
1 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
man/sxmsg_rreply.3SNTL
View File

@ -4,16 +4,28 @@ sxmsg_rreply \- Function used to send a rapid reply without confirmation
.SH SYNOPSIS .SH SYNOPSIS
.B #include <sntl/sntllv2.h> .B #include <sntl/sntllv2.h>
.sp .sp
.BI int sxmsg_rreply(sxmsg_t *msg, size_t datalen); int sxmsg_rreply(sxmsg_t
.BI *msg
, size_t
.BI datalen
);
.br .br
.sp .sp
.SH DESCRIPTION .SH DESCRIPTION
.B sxmsg_rreply .B sxmsg_rreply
Will reply rapidly to the message using already allocated buffer, which might be Will reply rapidly to the message using already allocated buffer, which must be
retrieved via sxmsg_rapidbuf(). This function will write desired message as soon retrieved via
as possible. It will not wait any write or delivery confirmation. .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 .br
.SH RETURN VALUE .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 .B SNE_FAILED
returns if message has invalid index, channel or message pointer is NULL. returns if message has invalid index, channel or message pointer is NULL.
.br .br
@ -33,3 +45,13 @@ Not known yet.
char *buf = sxmsg_rapidbuf(msg); char *buf = sxmsg_rapidbuf(msg);
int ln = snprintf(buf, MAX_BBUFLEN, "(is-done)"); int ln = snprintf(buf, MAX_BBUFLEN, "(is-done)");
return sxmsg_rreply(msg, str, ln); 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 <http://askele.com>
.SH AUTHOR
Alexander Vdolainen (vdo@askele.com)