Daniel Stenberg e694c8284a

docs/libcurl/opts: clarify the return values

Expand a little.

- mention the type name of the return code
- avoid stating which exact return codes that might be returned, as that
  varies over time, builds and conditions
- avoid stating some always return OK
- refer to the manpage documenting all the return codes

Closes #15900

2025-01-02 17:13:33 +01:00

1.4 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

Added-in

curl

CURLINFO_RTSP_SERVER_CSEQ

libcurl

CURLINFO_RTSP_CSEQ_RECV (3)

curl_easy_getinfo (3)

curl_easy_setopt (3)

RTSP

7.20.0

NAME

CURLINFO_RTSP_SERVER_CSEQ - get the next RTSP server CSeq

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_RTSP_SERVER_CSEQ,
                           long *cseq);

DESCRIPTION

Pass a pointer to a long to receive the next CSeq that is expected to be used by the application.

Listening for server initiated requests is not implemented.

Applications wishing to resume an RTSP session on another connection should retrieve this info before closing the active connection.

%PROTOCOLS%

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "rtsp://rtsp.example.com");
    res = curl_easy_perform(curl);
    if(res == CURLE_OK) {
      long cseq;
      curl_easy_getinfo(curl, CURLINFO_RTSP_SERVER_CSEQ, &cseq);
    }
    curl_easy_cleanup(curl);
  }
}

%AVAILABILITY%

RETURN VALUE

curl_easy_getinfo(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.4 KiB Raw Blame History