mirror of
https://github.com/curl/curl.git
synced 2026-05-23 19:06:23 +03:00
e3fe020089
Remove the PROTOCOLS section from the source files completely and instead generate them based on the header data in the curldown files. It also generates TLS backend information for options marked for TLS as protocol. Closes #13175
66 lines
1.4 KiB
Markdown
66 lines
1.4 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_RTSP_SESSION_ID
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_RTSP_REQUEST (3)
|
|
- CURLOPT_RTSP_STREAM_URI (3)
|
|
Protocol:
|
|
- RTSP
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_RTSP_SESSION_ID - RTSP session ID
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_SESSION_ID, char *id);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a char pointer as a parameter to set the value of the current RTSP
|
|
Session ID for the handle. Useful for resuming an in-progress session. Once
|
|
this value is set to any non-NULL value, libcurl returns
|
|
*CURLE_RTSP_SESSION_ERROR* if ID received from the server does not match. If
|
|
unset (or set to NULL), libcurl automatically sets the ID the first time the
|
|
server sets it in a response.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
|
|
# DEFAULT
|
|
|
|
NULL
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
char *prev_id; /* saved from before somehow */
|
|
curl_easy_setopt(curl, CURLOPT_URL, "rtsp://example.com/");
|
|
curl_easy_setopt(curl, CURLOPT_RTSP_SESSION_ID, prev_id);
|
|
res = curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.20.0
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|