curl/curl
1
1
Fork 0
mirror of https://github.com/curl/curl.git synced 2025-09-16 17:12:43 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs/WEBSOCKET.md: explain the URL use

Browse Source 
Fixes #9936
Closes #9941
This commit is contained in:
Daniel Stenberg 2022-11-18 09:39:26 +01:00
parent 12e1def51a
commit 117e3372a8
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/WEBSOCKET.md
View File

@ -6,6 +6,21 @@ SPDX-License-Identifier: curl
# WebSocket in curl
## URL
WebSocket communication with libcurl is done by setting up a transfer to a URL
using the `ws:/` or `wss://` URL schemes. The latter one being the secure
version done over HTTPS.
When using `wss://` to do WebSocket over HTTPS, the standard TLS and HTTPS
options will be acknowledged for the CA, verification of server certificate
etc.
WebSocket communication is done by upgrading a connection from either HTTP or
HTTPS. When given a WebSocket URL to work with, libcurl considers it a
transfer failure if the upgrade procedure fails. This means that a plain HTTP
200 response code is considered an error for this work.
## API
The WebSocket API is described in the individual man pages for the new API.