Artifactspublic-v0

curl

master
ply4 git calls130 ms289 KiB2 cachedprotocol v2
146 lines4.5 KiBRaw

NAME

CURLOPT_RTSP_REQUEST - RTSP request

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_REQUEST, long request);

DESCRIPTION

Tell libcurl what kind of RTSP request to make. Pass one of the following RTSP enum values as a long in the request argument. Unless noted otherwise, commands require the Session ID to be initialized.

CURL_RTSPREQ_OPTIONS

Used to retrieve the available methods of the server. The application is responsible for parsing and obeying the response. The session ID is not needed for this method.

CURL_RTSPREQ_DESCRIBE

Used to get the low level description of a stream. The application should note what formats it understands in the 'Accept:' header. Unless set manually, libcurl automatically adds in 'Accept: application/sdp'. Time-condition headers are added to Describe requests if the CURLOPT_TIMECONDITION(3) option is used. (The session ID is not needed for this method)

CURL_RTSPREQ_ANNOUNCE

When sent by a client, this method changes the description of the session. For example, if a client is using the server to record a meeting, the client can use Announce to inform the server of all the meta-information about the session. ANNOUNCE acts like an HTTP PUT or POST like CURL_RTSPREQ_SET_PARAMETER

CURL_RTSPREQ_SETUP

Setup is used to initialize the transport layer for the session. The application must set the desired Transport options for a session by using the CURLOPT_RTSP_TRANSPORT(3) option prior to calling setup. If no session ID is currently set with CURLOPT_RTSP_SESSION_ID(3), libcurl extracts and uses the session ID in the response to this request. The session ID is not needed for this method.

CURL_RTSPREQ_PLAY

Send a Play command to the server. Use the CURLOPT_RANGE(3) option to modify the playback time (e.g. npt=10-15).

CURL_RTSPREQ_PAUSE

Send a Pause command to the server. Use the CURLOPT_RANGE(3) option with a single value to indicate when the stream should be halted. (e.g. npt=25)

CURL_RTSPREQ_TEARDOWN

This command terminates an RTSP session. Closing a connection does not terminate the RTSP session since it is valid to control an RTSP session over different connections.

CURL_RTSPREQ_GET_PARAMETER

Retrieve a parameter from the server. By default, libcurl adds a Content-Type: text/parameters header on all non-empty requests unless a custom one is set. GET_PARAMETER acts like an HTTP PUT or POST (see CURL_RTSPREQ_SET_PARAMETER). Applications wishing to send a heartbeat message (e.g. in the presence of a server-specified timeout) should send use an empty GET_PARAMETER request.

CURL_RTSPREQ_SET_PARAMETER

Set a parameter on the server. By default, libcurl uses a Content-Type: text/parameters header unless a custom one is set. The interaction with SET_PARAMETER is much like an HTTP PUT or POST. An application may either use CURLOPT_UPLOAD(3) with CURLOPT_READDATA(3) like an HTTP PUT, or it may use CURLOPT_POSTFIELDS(3) like an HTTP POST. No chunked transfers are allowed, so the application must set the CURLOPT_INFILESIZE(3) in the former and CURLOPT_POSTFIELDSIZE(3) in the latter. Also, there is no use of multi-part POSTs within RTSP.

CURL_RTSPREQ_RECORD

Used to tell the server to record a session. Use the CURLOPT_RANGE(3) option to modify the record time.

CURL_RTSPREQ_RECEIVE

This is a special request because it does not send any data to the server. The application may call this function in order to receive interleaved RTP data. It returns after processing one read buffer of data in order to give the application a chance to run.

DEFAULT

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL, "rtsp://example.com/");
    /* ask for options */
    curl_easy_setopt(curl, CURLOPT_RTSP_REQUEST, CURL_RTSPREQ_OPTIONS);
    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

HISTORY

CURL_RTSPREQ_* enums became long types in 8.13.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_RTSP_REQUEST
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_RTSP_SESSION_ID (3)
9 - CURLOPT_RTSP_STREAM_URI (3)
10Protocol:
11 - RTSP
12Added-in: 7.20.0
13---
15# NAME
17CURLOPT_RTSP_REQUEST - RTSP request
19# SYNOPSIS
21~~~c
22#include <curl/curl.h>
24CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_REQUEST, long request);
25~~~
27# DESCRIPTION
29Tell libcurl what kind of RTSP request to make. Pass one of the following RTSP
30enum values as a long in the *request* argument. Unless noted otherwise,
31commands require the Session ID to be initialized.
33## CURL_RTSPREQ_OPTIONS
35Used to retrieve the available methods of the server. The application is
36responsible for parsing and obeying the response. The session ID is not needed
37for this method.
39## CURL_RTSPREQ_DESCRIBE
41Used to get the low level description of a stream. The application should note
42what formats it understands in the *'Accept:'* header. Unless set manually,
43libcurl automatically adds in *'Accept: application/sdp'*. Time-condition
44headers are added to Describe requests if the CURLOPT_TIMECONDITION(3)
45option is used. (The session ID is not needed for this method)
47## CURL_RTSPREQ_ANNOUNCE
49When sent by a client, this method changes the description of the session. For
50example, if a client is using the server to record a meeting, the client can
51use Announce to inform the server of all the meta-information about the
52session. ANNOUNCE acts like an HTTP PUT or POST like
53*CURL_RTSPREQ_SET_PARAMETER*
55## CURL_RTSPREQ_SETUP
57Setup is used to initialize the transport layer for the session. The
58application must set the desired Transport options for a session by using the
59CURLOPT_RTSP_TRANSPORT(3) option prior to calling setup. If no session
60ID is currently set with CURLOPT_RTSP_SESSION_ID(3), libcurl extracts
61and uses the session ID in the response to this request. The session ID is not
62needed for this method.
64## CURL_RTSPREQ_PLAY
66Send a Play command to the server. Use the CURLOPT_RANGE(3) option to
67modify the playback time (e.g. *npt=10-15*).
69## CURL_RTSPREQ_PAUSE
71Send a Pause command to the server. Use the CURLOPT_RANGE(3) option with
72a single value to indicate when the stream should be
73halted. (e.g. *npt=25*)
75## CURL_RTSPREQ_TEARDOWN
77This command terminates an RTSP session. Closing a connection does not
78terminate the RTSP session since it is valid to control an RTSP session over
79different connections.
81## CURL_RTSPREQ_GET_PARAMETER
83Retrieve a parameter from the server. By default, libcurl adds a
84*Content-Type: text/parameters* header on all non-empty requests unless a
85custom one is set. GET_PARAMETER acts like an HTTP PUT or POST (see
86*CURL_RTSPREQ_SET_PARAMETER*). Applications wishing to send a heartbeat
87message (e.g. in the presence of a server-specified timeout) should send use
88an empty GET_PARAMETER request.
90## CURL_RTSPREQ_SET_PARAMETER
92Set a parameter on the server. By default, libcurl uses a *Content-Type:
93text/parameters* header unless a custom one is set. The interaction with
94SET_PARAMETER is much like an HTTP PUT or POST. An application may either use
95CURLOPT_UPLOAD(3) with CURLOPT_READDATA(3) like an HTTP PUT, or it may use
96CURLOPT_POSTFIELDS(3) like an HTTP POST. No chunked transfers are allowed, so
97the application must set the CURLOPT_INFILESIZE(3) in the former and
98CURLOPT_POSTFIELDSIZE(3) in the latter. Also, there is no use of multi-part
99POSTs within RTSP.
101## CURL_RTSPREQ_RECORD
103Used to tell the server to record a session. Use the CURLOPT_RANGE(3)
104option to modify the record time.
106## CURL_RTSPREQ_RECEIVE
108This is a special request because it does not send any data to the server. The
109application may call this function in order to receive interleaved RTP
110data. It returns after processing one read buffer of data in order to give the
111application a chance to run.
113# DEFAULT
115# %PROTOCOLS%
117# EXAMPLE
119~~~c
120int main(void)
122 CURL *curl = curl_easy_init();
123 if(curl) {
124 CURLcode result;
125 curl_easy_setopt(curl, CURLOPT_URL, "rtsp://example.com/");
126 /* ask for options */
127 curl_easy_setopt(curl, CURLOPT_RTSP_REQUEST, CURL_RTSPREQ_OPTIONS);
128 result = curl_easy_perform(curl);
129 curl_easy_cleanup(curl);
130 }
132~~~
134# HISTORY
136**CURL_RTSPREQ_*** enums became `long` types in 8.13.0, prior to this version
137a `long` cast was necessary when passed to curl_easy_setopt(3).
139# %AVAILABILITY%
141# RETURN VALUE
143curl_easy_setopt(3) returns a CURLcode indicating success or error.
145CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
146libcurl-errors(3).
Diagnostics4 git calls · 130 ms
CallStatusSizeTime0130 ms
discover200152 B3 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 · hit3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=149
git.response.cache=HIT
git.response.duration_ms=3
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 · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=124
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=3
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
fetch2002.1 KiB124 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=2116
git.response.cache=MISS
git.response.duration_ms=124
git.fetch.wants=c9c00a4b100e77e6c6556594cd06dfeb334fcdd7
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=2116
git.pkt.payload.max=2095
git.sideband.band1.bytes=2094
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
a5e334955969f485
Request
1d7e62c8…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format