| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2014, 2017, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH CURLOPT_INTERLEAVEFUNCTION 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_INTERLEAVEFUNCTION \- callback function for RTSP interleaved data |
| 26 |
.SH SYNOPSIS |
| 27 |
.nf |
| 28 |
#include <curl/curl.h> |
| 29 |
|
| 30 |
size_t interleave_callback(void *ptr, size_t size, size_t nmemb, |
| 31 |
void *userdata); |
| 32 |
|
| 33 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERLEAVEFUNCTION, |
| 34 |
interleave_callback); |
| 35 |
.SH DESCRIPTION |
| 36 |
Pass a pointer to your callback function, which should match the prototype |
| 37 |
shown above. |
| 38 |
|
| 39 |
This callback function gets called by libcurl as soon as it has received |
| 40 |
interleaved RTP data. This function gets called for each $ block and therefore |
| 41 |
contains exactly one upper-layer protocol unit (e.g. one RTP packet). Curl |
| 42 |
writes the interleaved header as well as the included data for each call. The |
| 43 |
first byte is always an ASCII dollar sign. The dollar sign is followed by a |
| 44 |
one byte channel identifier and then a 2 byte integer length in network byte |
| 45 |
order. See \fIRFC2326 Section 10.12\fP for more information on how RTP |
| 46 |
interleaving behaves. If unset or set to NULL, curl will use the default write |
| 47 |
function. |
| 48 |
|
| 49 |
Interleaved RTP poses some challenges for the client application. Since the |
| 50 |
stream data is sharing the RTSP control connection, it is critical to service |
| 51 |
the RTP in a timely fashion. If the RTP data is not handled quickly, |
| 52 |
subsequent response processing may become unreasonably delayed and the |
| 53 |
connection may close. The application may use \fICURL_RTSPREQ_RECEIVE\fP to |
| 54 |
service RTP data when no requests are desired. If the application makes a |
| 55 |
request, (e.g. \fICURL_RTSPREQ_PAUSE\fP) then the response handler will |
| 56 |
process any pending RTP data before marking the request as finished. |
| 57 |
|
| 58 |
The \fICURLOPT_INTERLEAVEDATA(3)\fP is passed in the \fIuserdata\fP argument in |
| 59 |
the callback. |
| 60 |
.SH DEFAULT |
| 61 |
NULL, the interleave data is then passed to the regular write function: |
| 62 |
\fICURLOPT_WRITEFUNCTION(3)\fP. |
| 63 |
.SH PROTOCOLS |
| 64 |
RTSP |
| 65 |
.SH EXAMPLE |
| 66 |
.nf |
| 67 |
static size_t rtp_write(void *ptr, size_t size, size_t nmemb, void *user) |
| 68 |
{ |
| 69 |
struct local *l = (struct local *)user; |
| 70 |
/* take care of the packet in 'ptr', then return... */ |
| 71 |
return size * nmemb; |
| 72 |
} |
| 73 |
{ |
| 74 |
struct local rtp_data; |
| 75 |
curl_easy_setopt(curl, CURLOPT_INTERLEAVEFUNCTION, rtp_write); |
| 76 |
curl_easy_setopt(curl, CURLOPT_INTERLEAVEDATA, &rtp_data); |
| 77 |
} |
| 78 |
.fi |
| 79 |
.SH AVAILABILITY |
| 80 |
Added in 7.20.0 |
| 81 |
.SH RETURN VALUE |
| 82 |
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| 83 |
.SH "SEE ALSO" |
| 84 |
.BR CURLOPT_INTERLEAVEDATA "(3), " CURLOPT_RTSP_REQUEST "(3), " |