.\" Man page generated from reStructuredText.
.
.TH "WSLAY_EVENT_SEND" "3" "Dec 29, 2017" "@PACKAGE_VERSION@" "wslay"
.SH NAME
wslay_event_send \- Send any pending messages
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
#include <wslay/wslay.h>
.INDENT 0.0
.TP
.B int wslay_event_send(wslay_event_context_ptr\fI\ ctx\fP)
.UNINDENT
.SH DESCRIPTION
.sp
\fI\%wslay_event_send()\fP sends queued messages to peer.
When sending a message, it uses
\fBwslay_event_send_callback\fP function.
Single call of \fI\%wslay_event_send()\fP sends multiple messages
until \fBwslay_event_send_callback\fP sets error code
\fBWSLAY_ERR_WOULDBLOCK\fP\&.
.sp
If \fIctx\fP is initialized for WebSocket client use,
\fI\%wslay_event_send()\fP uses \fBwslay_event_genmask_callback\fP
to get new mask key.
.sp
When a message queued using \fBwslay_event_queue_fragmented_msg()\fP is sent,
\fI\%wslay_event_send()\fP invokes
\fBwslay_event_fragmented_msg_callback\fP for that message.
.sp
After close control frame is sent, this function
calls \fBwslay_event_set_write_enabled()\fP with second argument
0 to disable further transmission to peer.
.sp
If there are any pending messages, \fBwslay_event_want_write()\fP
returns 1, otherwise returns 0.
.sp
In case of a fatal error which leads to negative return code,
this function calls \fBwslay_event_set_write_enabled()\fP with second argument
0 to disable further transmission to peer.
.SH RETURN VALUE
.sp
\fI\%wslay_event_send()\fP returns 0 if it succeeds, or one of the following
negative error codes:
.INDENT 0.0
.TP
.B WSLAY_ERR_CALLBACK_FAILURE
User defined callback function is failed.
.UNINDENT
.INDENT 0.0
.TP
.B WSLAY_ERR_NOMEM
Out of memory.
.UNINDENT
.sp
When negative error code is returned, application must not make any further
call of \fI\%wslay_event_send()\fP and must close WebSocket connection.
.SH SEE ALSO
.sp
\fBwslay_event_queue_fragmented_msg()\fP,
\fBwslay_event_set_write_enabled()\fP,
\fBwslay_event_want_write()\fP
.SH AUTHOR
Tatsuhiro Tsujikawa
.SH COPYRIGHT
2017, 2015, Tatsuhiro Tsujikawa
.\" Generated by docutils manpage writer.
.