Artifactspublic-v0

curl

master
ply4 git calls165 ms288 KiB2 cachedprotocol v2
90 lines1.9 KiBRaw

NAME

CURLOPT_WS_OPTIONS - WebSocket behavior options

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_WS_OPTIONS, long bitmask);

DESCRIPTION

Pass a long with a bitmask to tell libcurl about specific WebSocket behaviors.

To detach a WebSocket connection and use the curl_ws_send(3) and curl_ws_recv(3) functions after the HTTP upgrade procedure, set the CURLOPT_CONNECT_ONLY(3) option to 2L.

Available bits in the bitmask

CURLWS_RAW_MODE (1)

Deliver "raw" WebSocket traffic to the CURLOPT_WRITEFUNCTION(3) callback. Read "raw" WebSocket traffic from the CURLOPT_READFUNCTION(3) callback.

In raw mode, libcurl does not handle pings or any other frame for the application.

CURLWS_NOAUTOPONG (2)

Disable the automatic reply to PING messages. This means users must send a PONG message with curl_ws_send(3). This feature is added with version 8.14.0.

DEFAULT

0

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL, "ws://example.com/");
    /* tell curl we deal with all the WebSocket logic ourselves */
    curl_easy_setopt(curl, CURLOPT_WS_OPTIONS, CURLWS_RAW_MODE);
    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

HISTORY

CURLWS_RAW_MODE and CURLWS_NOAUTOPONG macros became long types in 8.16.0, prior to this version a long cast was necessary when passed to curl_easy_setopt(3).

%AVAILABILITY%

RETURN VALUE

curl_easy_setopt(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).

1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_WS_OPTIONS
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_CONNECT_ONLY (3)
9 - curl_ws_recv (3)
10 - curl_ws_send (3)
11Protocol:
12 - WS
13Added-in: 7.86.0
14---
16# NAME
18CURLOPT_WS_OPTIONS - WebSocket behavior options
20# SYNOPSIS
22~~~c
23#include <curl/curl.h>
25CURLcode curl_easy_setopt(CURL *handle, CURLOPT_WS_OPTIONS, long bitmask);
26~~~
28# DESCRIPTION
30Pass a long with a bitmask to tell libcurl about specific WebSocket
31behaviors.
33To detach a WebSocket connection and use the curl_ws_send(3) and
34curl_ws_recv(3) functions after the HTTP upgrade procedure, set the
35CURLOPT_CONNECT_ONLY(3) option to 2L.
37Available bits in the bitmask
39## CURLWS_RAW_MODE (1)
41Deliver "raw" WebSocket traffic to the CURLOPT_WRITEFUNCTION(3)
42callback. Read "raw" WebSocket traffic from the CURLOPT_READFUNCTION(3)
43callback.
45In raw mode, libcurl does not handle pings or any other frame for the
46application.
48## CURLWS_NOAUTOPONG (2)
50Disable the automatic reply to PING messages. This means users must
51send a PONG message with curl_ws_send(3). This feature is added with
52version 8.14.0.
54# DEFAULT
58# %PROTOCOLS%
60# EXAMPLE
62~~~c
63int main(void)
65 CURL *curl = curl_easy_init();
66 if(curl) {
67 CURLcode result;
68 curl_easy_setopt(curl, CURLOPT_URL, "ws://example.com/");
69 /* tell curl we deal with all the WebSocket logic ourselves */
70 curl_easy_setopt(curl, CURLOPT_WS_OPTIONS, CURLWS_RAW_MODE);
71 result = curl_easy_perform(curl);
72 curl_easy_cleanup(curl);
73 }
75~~~
77# HISTORY
79**CURLWS_RAW_MODE** and **CURLWS_NOAUTOPONG** macros became `long` types
80in 8.16.0, prior to this version a `long` cast was necessary when passed
81to curl_easy_setopt(3).
83# %AVAILABILITY%
85# RETURN VALUE
87curl_easy_setopt(3) returns a CURLcode indicating success or error.
89CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
90libcurl-errors(3).
Diagnostics4 git calls · 165 ms
CallStatusSizeTime0165 ms
discover200152 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=152
git.server.agent=gitty/1.0
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch object-format
git.server.fetch=shallow filter sideband-all
git.protocol.version=2
git.pkt.frames=8
git.pkt.data=6
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=152
git.pkt.payload.max=34
ls-refs200149 B · hit2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=149
git.response.cache=HIT
git.response.duration_ms=2
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=149
git.pkt.payload.max=78
git.ls_refs.count=2
git.ls_refs.head=refs/heads/master
fetchblob:none · deepen 10200287 KiB · hit4 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=159
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=4
git.fetch.filter=blob:none
git.fetch.filter.requested=tree:0
git.fetch.filter.fallback=blob:none
git.fetch.filter.learned=false
git.fetch.wants=31c911efe5652725e930f4d2e60c9060e5f6646d
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=10
git.pkt.data=8
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=293470
git.pkt.payload.max=65516
git.sideband.band1.bytes=293354
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=87
git.pack.bytes=293354
git.pack.ofs_delta=0
git.pack.ref_delta=1
git.pack.chain.max=1
git.pack.trailer=6a646bcda6740bab42e321b51998b52ea15146c0
git.pack.full=86
Open pack map
fetch2001.1 KiB159 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1104
git.response.cache=MISS
git.response.duration_ms=159
git.fetch.wants=965183b38f53323759f4bdff060784936a272440
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1104
git.pkt.payload.max=1083
git.sideband.band1.bytes=1082
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://5ad2236b39de4c8bd8f6270ea63f3ea9.artifacts.cloudflare.net/git/public-v0/curl.git
Ref
refs/heads/master
Commit
31c911efe5652725e930f4d2e60c9060e5f6646d
cf-ray
a5e35cc7c9f85cd4
Request
2c8cd169…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format