moparisthebest
/
curl
mirror of https://github.com/moparisthebest/curl
1
0
Fork 0
Code Issues Releases Wiki Activity

docs: clarify the CURLOPT_INTERLEAVE* options behavior

This commit is contained in:
Daniel Stenberg 2017-09-15 15:47:56 +02:00
parent 08dbed31d5
commit 50b208e23e
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/libcurl/opts/CURLOPT_INTERLEAVEDATA.3
View File

@ -22,15 +22,16 @@
.\" .\"
.TH CURLOPT_INTERLEAVEDATA 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" .TH CURLOPT_INTERLEAVEDATA 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
.SH NAME .SH NAME
CURLOPT_INTERLEAVEDATA \- custom pointer to RTSP interleave callback CURLOPT_INTERLEAVEDATA \- custom pointer passed to RTSP interleave callback
.SH SYNOPSIS .SH SYNOPSIS
#include <curl/curl.h> #include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERLEAVEDATA, void *pointer); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERLEAVEDATA, void *pointer);
.SH DESCRIPTION .SH DESCRIPTION
This is the userdata \fIpointer\fP that will be passed to This is the userdata \fIpointer\fP that will be passed to
\fICURLOPT_INTERLEAVEFUNCTION(3)\fP when interleaved RTP data is \fICURLOPT_INTERLEAVEFUNCTION(3)\fP when interleaved RTP data is received. If
received. the interleave function callback is not set, this pointer is not used
anywhere.
.SH DEFAULT .SH DEFAULT
NULL NULL
.SH PROTOCOLS .SH PROTOCOLS

8
docs/libcurl/opts/CURLOPT_INTERLEAVEFUNCTION.3
View File

@ -54,8 +54,12 @@ connection may close. The application may use \fICURL_RTSPREQ_RECEIVE\fP to
service RTP data when no requests are desired. If the application makes a service RTP data when no requests are desired. If the application makes a
request, (e.g. \fICURL_RTSPREQ_PAUSE\fP) then the response handler will request, (e.g. \fICURL_RTSPREQ_PAUSE\fP) then the response handler will
process any pending RTP data before marking the request as finished. process any pending RTP data before marking the request as finished.
The \fICURLOPT_WRITEDATA(3)\fP is passed in the \fIuserdata\fP argument in the
callback.
.SH DEFAULT .SH DEFAULT
NULL NULL, the interleave data is then passed to the regular write function:
\fICURLOPT_WRITEFUNCTION(3)\fP.
.SH PROTOCOLS .SH PROTOCOLS
RTSP RTSP
.SH EXAMPLE .SH EXAMPLE
@ -77,4 +81,4 @@ Added in 7.20.0
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_INTERLEAVEFUNCTION "(3), " CURLOPT_RTSP_REQUEST "(3), " .BR CURLOPT_INTERLEAVEDATA "(3), " CURLOPT_RTSP_REQUEST "(3), "