|
|
|
|
.TH SXMSG_RETURN 3 "20 July 2015" "SXMP" "SXMP Library Manual"
|
|
|
|
|
.SH NAME
|
|
|
|
|
sxmsg_return \- Return a message with error and close dialog.
|
|
|
|
|
.br
|
|
|
|
|
sxmsg_return_pp \- Return a message with error and close dialog in postponed message send mode.
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B #include <sxmp/sxmp.h>
|
|
|
|
|
.br
|
|
|
|
|
.sp
|
|
|
|
|
int sxmsg_return(sxmsg_t *msg, int opcode);
|
|
|
|
|
|
|
|
|
|
int sxmsg_return_pp(sxmsg_t *msg, int opcode);
|
|
|
|
|
|
|
|
|
|
.br
|
|
|
|
|
.sp
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.B sxmsg_return
|
|
|
|
|
Will return a message with error code
|
|
|
|
|
.B opcode
|
|
|
|
|
pointed by
|
|
|
|
|
.B msg.
|
|
|
|
|
This message will be sent within context of the calling thread.
|
|
|
|
|
.br
|
|
|
|
|
.B sxmsg_reply_pp
|
|
|
|
|
Will do exactly the same, but message sending will be postponed and sent by one of the thread serving the underlying connection link.
|
|
|
|
|
.br
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Functions may fail with the following errors:
|
|
|
|
|
.br
|
|
|
|
|
.B SXE_SUCCESS
|
|
|
|
|
will returns if message was processed and dialog is closed.
|
|
|
|
|
.br
|
|
|
|
|
.B SXE_FAILED
|
|
|
|
|
pointed data is invalid.
|
|
|
|
|
.br
|
|
|
|
|
.B SXE_ENOMEM
|
|
|
|
|
not available memory for operation.
|
|
|
|
|
.br
|
|
|
|
|
.B SXE_BADPROTO
|
|
|
|
|
bad protocol.
|
|
|
|
|
.br
|
|
|
|
|
.B SXE_NOSUCHCHAN
|
|
|
|
|
Pointed channel doesn't exists
|
|
|
|
|
.br
|
|
|
|
|
.B SXE_ETIMEDOUT
|
|
|
|
|
Other side timedout with replying to your message.
|
|
|
|
|
.br
|
|
|
|
|
.B SXE_LINKBROKEN
|
|
|
|
|
Connection link is broken during a message send.
|
|
|
|
|
.br
|
|
|
|
|
.SH BUGS
|
|
|
|
|
Not known yet.
|
|
|
|
|
.SH EXAMPLE
|
|
|
|
|
None.
|
|
|
|
|
.SH APPLICATION USAGE
|
|
|
|
|
None.
|
|
|
|
|
.SH RATIONALE
|
|
|
|
|
None.
|
|
|
|
|
.SH SEE_ALSO
|
|
|
|
|
.BI sxchannel_open(3)
|
|
|
|
|
,
|
|
|
|
|
.BI sxchannel_close(3)
|
|
|
|
|
,
|
|
|
|
|
.BI sxmsg_reply(3)
|
|
|
|
|
,
|
|
|
|
|
.BI sxmsg_rreply(3)
|
|
|
|
|
,
|
|
|
|
|
.BI sxmsg_return(3)
|
|
|
|
|
,
|
|
|
|
|
.BI sxmsg_send(3)
|
|
|
|
|
.SH COPYRIGHT
|
|
|
|
|
This software licensed under GNU LGPL v2.1. See COPYING for further details.
|
|
|
|
|
.br
|
|
|
|
|
(c) Askele Group 2013-2015 <http://askele.com>
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
Alexander Vdolainen (vdo@askele.com)
|
