mirror of
https://github.com/curl/curl.git
synced 2024-12-15 06:40:09 +08:00
74 lines
2.4 KiB
Groff
74 lines
2.4 KiB
Groff
.\" **************************************************************************
|
||
.\" * _ _ ____ _
|
||
.\" * Project ___| | | | _ \| |
|
||
.\" * / __| | | | |_) | |
|
||
.\" * | (__| |_| | _ <| |___
|
||
.\" * \___|\___/|_| \_\_____|
|
||
.\" *
|
||
.\" * Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
|
||
.\" *
|
||
.\" * This software is licensed as described in the file COPYING, which
|
||
.\" * you should have received as part of this distribution. The terms
|
||
.\" * are also available at https://curl.se/docs/copyright.html.
|
||
.\" *
|
||
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
||
.\" * copies of the Software, and permit persons to whom the Software is
|
||
.\" * furnished to do so, under the terms of the COPYING file.
|
||
.\" *
|
||
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
||
.\" * KIND, either express or implied.
|
||
.\" *
|
||
.\" * SPDX-License-Identifier: curl
|
||
.\" *
|
||
.\" **************************************************************************
|
||
.\"
|
||
.TH curl_ws_send 3 "12 Jun 2022" "libcurl 7.85.0" "libcurl Manual"
|
||
.SH NAME
|
||
curl_ws_send - receive websocket data
|
||
.SH SYNOPSIS
|
||
.nf
|
||
#include <curl/easy.h>
|
||
|
||
CURLcode curl_ws_send(CURL *curl, char *buffer, size_t buflen, size_t *sent,
|
||
unsigned int sendflags);
|
||
.fi
|
||
.SH DESCRIPTION
|
||
This function call is EXPERIMENTAL.
|
||
|
||
Send the specific message fragment over the established websockets connection.
|
||
|
||
If \fBCURLWS_RAW_MODE\fP is enabled in \fICURLOPT_WS_OPTIONS(3)\fP, the
|
||
\fBsendflags\fP argument should be set to 0.
|
||
|
||
.SH SENDFLAGS
|
||
.IP CURLWS_TEXT
|
||
The buffer contains text data. Note that this makes a difference to WebSockets
|
||
but libcurl itself will not make any verification of the content or
|
||
precautions that you actually send valid UTF-8 content.
|
||
.IP CURLWS_BINARY
|
||
This is binary data.
|
||
.IP CURLWS_NOCOMPRESS
|
||
No-op if there’s no compression anyway.
|
||
.IP CURLWS_CONT
|
||
This is not the final fragment of the message, which implies that there will
|
||
be another fragment coming as part of the same message where this bit is not
|
||
set.
|
||
.IP CURLWS_CLOSE
|
||
Close this transfer.
|
||
.IP CURLWS_PING
|
||
This as a ping.
|
||
.IP CURLWS_PONG
|
||
This as a pong.
|
||
.SH EXAMPLE
|
||
.nf
|
||
|
||
.fi
|
||
.SH AVAILABILITY
|
||
Added in 7.86.0.
|
||
.SH RETURN VALUE
|
||
|
||
.SH "SEE ALSO"
|
||
.BR curl_easy_setopt "(3), " curl_easy_perform "(3), "
|
||
.BR curl_easy_getinfo "(3), "
|
||
.BR curl_ws_recv "(3) "
|