2015-10-27 00:20:44 +02:00
|
|
|
.TH SXMSG_PULSE 3 "20 July 2015" "SXMP" "SXMP Library Manual"
|
2015-08-05 11:39:14 +03:00
|
|
|
.SH NAME
|
|
|
|
|
sxmsg_pulse \- Function used to send a pulse
|
|
|
|
|
.SH SYNOPSIS
|
2015-10-27 00:20:44 +02:00
|
|
|
.B #include <sxmp/sxmp.h>
|
2015-08-05 11:39:14 +03:00
|
|
|
.sp
|
2015-11-13 14:23:05 +02:00
|
|
|
int sxmsg_pulse(sxlink_t *co, const char *data, size_t datalen);
|
2015-08-05 11:39:14 +03:00
|
|
|
.sp
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.B sxmsg_pulse
|
2015-11-13 14:23:05 +02:00
|
|
|
Will send a pulse message to the peer of underlying link
|
2015-08-05 11:39:14 +03:00
|
|
|
.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
|
2015-11-13 14:23:05 +02:00
|
|
|
.B SXE_SUCCESS
|
2015-08-05 11:39:14 +03:00
|
|
|
Othrewise other error code will be returned.
|
|
|
|
|
.SH ERRORS
|
2015-11-13 14:23:05 +02:00
|
|
|
.B SXE_FAILED
|
2015-08-05 11:39:14 +03:00
|
|
|
returns if message has invalid index, channel or message pointer is NULL.
|
|
|
|
|
.br
|
2015-11-13 14:23:05 +02:00
|
|
|
.B SXE_ESSL
|
2015-08-05 11:39:14 +03:00
|
|
|
returns if write was failed i.e. connection link was broken, or SSL error occurs.
|
|
|
|
|
.br
|
2015-11-13 14:23:05 +02:00
|
|
|
.B SXE_EBUSY
|
2015-08-05 11:39:14 +03:00
|
|
|
Limit exceed.
|
2015-11-13 14:23:05 +02:00
|
|
|
.B SXE_SUCCESS
|
2015-08-05 11:39:14 +03:00
|
|
|
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
|
2015-12-29 22:42:52 +02:00
|
|
|
This software licensed under GNU LGPL v3. See COPYING for further details.
|
2015-08-05 11:39:14 +03:00
|
|
|
.br
|
|
|
|
|
(c) Askele Group 2013-2015 <http://askele.com>
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
Alexander Vdolainen (vdo@askele.com)
|
