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

fixes in manpages;

Browse Source
This commit is contained in:
Alexander Vdolainen 2015-11-13 14:23:05 +02:00
parent bb124198c9
commit 78d6226a43
5 changed files with 45 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
man/sxmsg_pulse.3
View File

@ -4,11 +4,11 @@ sxmsg_pulse \- Function used to send a pulse
.SH SYNOPSIS
.B #include <sxmp/sxmp.h>
.sp
int sxmsg_pulse(conn_t *co, const char *data, size_t datalen);
int sxmsg_pulse(sxlink_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
Will send a pulse message to the peer of underlying link
.B co
with given buffer
.B data
@ -17,18 +17,18 @@ with given length in bytes
.br
.SH RETURN VALUE
Upon successful completion, the function will write a pulse message returning
.B SNE_SUCCESS
.B SXE_SUCCESS
Othrewise other error code will be returned.
.SH ERRORS
.B SNE_FAILED
.B SXE_FAILED
returns if message has invalid index, channel or message pointer is NULL.
.br
.B SNE_ESSL
.B SXE_ESSL
returns if write was failed i.e. connection link was broken, or SSL error occurs.
.br
.B SNE_EBUSY
.B SXE_EBUSY
Limit exceed.
.B SNE_SUCCESS
.B SXE_SUCCESS
returns on success.
.br
.SH BUGS

24
man/sxmsg_reply.3
View File

@ -33,39 +33,39 @@ If dialogs will be not finished correctly the limit of active messages will be e
.SH RETURN VALUE
Dialog will be closed in all cases except the following error codes returns:
.sp
.B SNE_REPLYREQ
.B SXE_REPLYREQ
means other side waiting a reply for this message (i.e. dialog isn't closed).
.br
Other possible errors:
.br
.B SNE_SUCCESS
.B SXE_SUCCESS
will returns if message was processed and dialog is closed.
.br
.B SNE_FAILED
.B SXE_FAILED
pointed data is invalid.
.br
.B SNE_ENOMEM
.B SXE_ENOMEM
not available memory for operation.
.br
.B SNE_BADPROTO
.B SXE_BADPROTO
bad protocol.
.br
.B SNE_ENORPC
.B SXE_ENORPC
No RPC call exists i.e. message sent contains an invalid RPC function name.
.br
.B SNE_TOOLONG
.B SXE_TOOLONG
Data os too long to be sent with one message.
.br
.B SNE_NOSUCHCHAN
.B SXE_NOSUCHCHAN
Pointed channel doesn't exists
.br
.B SNE_ETIMEDOUT
.B SXE_ETIMEDOUT
Other side timedout with replying to your message.
.br
.B SNE_LINKBROKEN
.B SXE_LINKBROKEN
Connection link is broken during a message send.
.br
.B SNE_MMESSAGES
.B SXE_MMESSAGES
Limit for the active messages exceeded.
.br
.SH BUGS
@ -77,7 +77,7 @@ None.
.SH RATIONALE
None.
.SH SEE_ALSO
.BI connection_link(3)
.BI sxlink_connect(3)
,
.BI sxchannel_open(3)
,

14
man/sxmsg_return.3
View File

@ -27,25 +27,25 @@ Will do exactly the same, but message sending will be postponed and sent by one
.SH RETURN VALUE
Functions may fail with the following errors:
.br
.B SNE_SUCCESS
.B SXE_SUCCESS
will returns if message was processed and dialog is closed.
.br
.B SNE_FAILED
.B SXE_FAILED
pointed data is invalid.
.br
.B SNE_ENOMEM
.B SXE_ENOMEM
not available memory for operation.
.br
.B SNE_BADPROTO
.B SXE_BADPROTO
bad protocol.
.br
.B SNE_NOSUCHCHAN
.B SXE_NOSUCHCHAN
Pointed channel doesn't exists
.br
.B SNE_ETIMEDOUT
.B SXE_ETIMEDOUT
Other side timedout with replying to your message.
.br
.B SNE_LINKBROKEN
.B SXE_LINKBROKEN
Connection link is broken during a message send.
.br
.SH BUGS

8
man/sxmsg_rreply.3
View File

@ -25,14 +25,14 @@ message dialog if message is valid.
.SH RETURN VALUE
Upon successful completion, the function shall rapidly send a message reply and close
the message dialog returning
.B SNE_SUCCESS
.B SXE_SUCCESS
Othrewise other error code will be returned.
.SH ERRORS
.B SNE_FAILED
.B SXE_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.
.B SXE_ESSL
returns if write was failed i.e. link was broken, or SSL error occurs.
.br
.B SNE_SUCCESS
returns on success.

30
man/sxmsg_send.3
View File

@ -7,9 +7,9 @@ sxmsg_send_pp \- Create and send a message in postponed mode.
.B #include <sxmp/sxmp.h>
.br
.sp
int sxmsg_send(chnl_t *channel, const char *data, size_t datalen, sxmsg_t **msg);
int sxmsg_send(sxchnl_t *channel, const char *data, size_t datalen, sxmsg_t **msg);
int sxmsg_send_pp(chnl_t *channel, const char *data, size_t datalen, sxmsg_t **msg);
int sxmsg_send_pp(sxchnl_t *channel, const char *data, size_t datalen, sxmsg_t **msg);
void sxmsg_clean(sxmsg_t *msg);
.br
@ -38,43 +38,43 @@ will clean up the data used for closed dialog message, it should be used in case
.SH RETURN VALUE
Dialog will be closed in all cases except the following error codes returns:
.sp
.B SNE_REPLYREQ
.B SXE_REPLYREQ
means other side waiting a reply for this message (i.e. dialog isn't closed).
.br
In other cases message will not set except
.B SNE_RAPIDMSG
.B SXE_RAPIDMSG
error code, in this case to avoid memory leaks
.B sxmsg_clean
must be called after data is processed. In other cases a different and specific error code might be returned, but usual cases listed below:
.br
.B SNE_SUCCESS
.B SXE_SUCCESS
will returns if message was processed and dialog is closed.
.br
.B SNE_FAILED
.B SXE_FAILED
pointed data is invalid.
.br
.B SNE_ENOMEM
.B SXE_ENOMEM
not available memory for operation.
.br
.B SNE_BADPROTO
.B SXE_BADPROTO
bad protocol.
.br
.B SNE_ENORPC
.B SXE_ENORPC
No RPC call exists i.e. message sent contains an invalid RPC function name.
.br
.B SNE_TOOLONG
.B SXE_TOOLONG
Data os too long to be sent with one message.
.br
.B SNE_NOSUCHCHAN
.B SXE_NOSUCHCHAN
Pointed channel doesn't exists
.br
.B SNE_ETIMEDOUT
.B SXE_ETIMEDOUT
Other side timedout with replying to your message.
.br
.B SNE_LINKBROKEN
.B SXE_LINKBROKEN
Connection link is broken during a message send.
.br
.B SNE_MMESSAGES
.B SXE_MMESSAGES
Limit for the active messages exceeded.
.br
.SH BUGS
@ -86,7 +86,7 @@ None.
.SH RATIONALE
None.
.SH SEE_ALSO
.BI connection_link(3)
.BI sxlink_connect(3)
,
.BI sxchannel_open(3)
,