X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=ceph%2Fsrc%2Fcivetweb%2Fdocs%2Fapi%2Fmg_websocket_client_write.md;fp=ceph%2Fsrc%2Fcivetweb%2Fdocs%2Fapi%2Fmg_websocket_client_write.md;h=f792f4c7a1632a053cf8d21d7f689d230e711799;hb=37b3c99879b9f0c6b723fae450aeee022a7a653a;hp=0000000000000000000000000000000000000000;hpb=39cfebf25a7011204a9876d2950e4b28aba66d11;p=ceph.git

diff --git a/ceph/src/civetweb/docs/api/mg_websocket_client_write.md b/ceph/src/civetweb/docs/api/mg_websocket_client_write.md
new file mode 100644
index 000000000..f792f4c7a
--- /dev/null
+++ b/ceph/src/civetweb/docs/api/mg_websocket_client_write.md
@@ -0,0 +1,32 @@
+# Civetweb API Reference
+
+### `mg_websocket_client_write( conn, opcode, data, data_len );`
+
+### Parameters
+
+| Parameter | Type | Description |
+| :--- | :--- | :--- |
+|**`conn`**|`struct mg_connection *`|Connection on which to send data|
+|**`opcode`**|`int`|Opcode|
+|**`data const`**|`char *`|The data to be written|
+|**`data_len`**|`size_t`|Length of the data buffer|
+
+### Return Value
+
+| Type | Description |
+| :--- | :--- |
+|`int`|Number of bytes written or an error code|
+
+### Description
+
+The function `mg_websocket_client_write()` sends data to a websocket server wrapped in a masked websocket frame. The function issues calls to [`mg_lock_connection()`](mg_lock_connection.md) and [`mg_unlock_connection()`](mg_unlock_connection.md) to ensure that the transmission is not interrupted. Interruption can happen the the application is proactively communicating and responding to a request simultaneously. This function is available only, if Civetweb is compiled with the option `-DUSE_WEBSOCKET`.
+
+The return value is the number of bytes written on success, **0** when the connection has been closed and **-1** if an error occured.
+
+### See Also
+
+* [`mg_lock_connection();`](mg_lock_connection.md)
+* [`mg_printf();`](mg_printf.md)
+* [`mg_unlock_connection();`](mg_unlock_connection.md)
+* [`mg_websocket_write();`](mg_websocket_write.md)
+* [`mg_write();`](mg_write.md)