You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
48 lines
1.2 KiB
Groff
48 lines
1.2 KiB
Groff
9 years ago
|
.TH SXMSG_PULSE 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
|
||
|
|
.SH NAME
|
||
|
|
sxmsg_pulse \- Function used to send a pulse
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.B #include <sntl/sntllv2.h>
|
||
|
|
.sp
|
||
|
|
int sxmsg_pulse(conn_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
|
||
|
|
.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
|
||
|
|
.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
|
||
|
|
.B SNE_ESSL
|
||
|
|
returns if write was failed i.e. connection link was broken, or SSL error occurs.
|
||
|
|
.br
|
||
|
|
.B SNE_EBUSY
|
||
|
|
Limit exceed.
|
||
|
|
.B SNE_SUCCESS
|
||
|
|
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
|
||
|
|
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)
|