xref: /aosp_15_r20/external/curl/docs/libcurl/opts/CURLOPT_HTTP200ALIASES.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerTitle: CURLOPT_HTTP200ALIASES
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerProtocol:
8*6236dae4SAndroid Build Coastguard Worker  - HTTP
9*6236dae4SAndroid Build Coastguard WorkerSee-also:
10*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_HTTP09_ALLOWED (3)
11*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_HTTP_VERSION (3)
12*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.10.3
13*6236dae4SAndroid Build Coastguard Worker---
14*6236dae4SAndroid Build Coastguard Worker
15*6236dae4SAndroid Build Coastguard Worker# NAME
16*6236dae4SAndroid Build Coastguard Worker
17*6236dae4SAndroid Build Coastguard WorkerCURLOPT_HTTP200ALIASES - alternative matches for HTTP 200 OK
18*6236dae4SAndroid Build Coastguard Worker
19*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
20*6236dae4SAndroid Build Coastguard Worker
21*6236dae4SAndroid Build Coastguard Worker~~~c
22*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
23*6236dae4SAndroid Build Coastguard Worker
24*6236dae4SAndroid Build Coastguard WorkerCURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTP200ALIASES,
25*6236dae4SAndroid Build Coastguard Worker                          struct curl_slist *aliases);
26*6236dae4SAndroid Build Coastguard Worker~~~
27*6236dae4SAndroid Build Coastguard Worker
28*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
29*6236dae4SAndroid Build Coastguard Worker
30*6236dae4SAndroid Build Coastguard WorkerPass a pointer to a linked list of *aliases* to be treated as valid HTTP 200
31*6236dae4SAndroid Build Coastguard Workerresponses. Some servers respond with a custom header response line. For
32*6236dae4SAndroid Build Coastguard Workerexample, SHOUTcast servers respond with "ICY 200 OK". Also some old Icecast
33*6236dae4SAndroid Build Coastguard Worker1.3.x servers respond like that for certain user agent headers or in absence
34*6236dae4SAndroid Build Coastguard Workerof such. By including this string in your list of aliases, the response gets
35*6236dae4SAndroid Build Coastguard Workertreated as a valid HTTP header line such as "HTTP/1.0 200 OK".
36*6236dae4SAndroid Build Coastguard Worker
37*6236dae4SAndroid Build Coastguard WorkerThe linked list should be a fully valid list of struct curl_slist structs, and
38*6236dae4SAndroid Build Coastguard Workerbe properly filled in. Use curl_slist_append(3) to create the list and
39*6236dae4SAndroid Build Coastguard Workercurl_slist_free_all(3) to clean up an entire list.
40*6236dae4SAndroid Build Coastguard Worker
41*6236dae4SAndroid Build Coastguard WorkerThe alias itself is not parsed for any version strings. The protocol is
42*6236dae4SAndroid Build Coastguard Workerassumed to match HTTP 1.0 when an alias match.
43*6236dae4SAndroid Build Coastguard Worker
44*6236dae4SAndroid Build Coastguard WorkerUsing this option multiple times makes the last set list override the previous
45*6236dae4SAndroid Build Coastguard Workerones. Set it to NULL to disable its use again.
46*6236dae4SAndroid Build Coastguard Worker
47*6236dae4SAndroid Build Coastguard Workerlibcurl does not copy the list, it needs to be kept around until after the
48*6236dae4SAndroid Build Coastguard Workertransfer has completed.
49*6236dae4SAndroid Build Coastguard Worker
50*6236dae4SAndroid Build Coastguard Worker# DEFAULT
51*6236dae4SAndroid Build Coastguard Worker
52*6236dae4SAndroid Build Coastguard WorkerNULL
53*6236dae4SAndroid Build Coastguard Worker
54*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
55*6236dae4SAndroid Build Coastguard Worker
56*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
57*6236dae4SAndroid Build Coastguard Worker
58*6236dae4SAndroid Build Coastguard Worker~~~c
59*6236dae4SAndroid Build Coastguard Workerint main(void)
60*6236dae4SAndroid Build Coastguard Worker{
61*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
62*6236dae4SAndroid Build Coastguard Worker  if(curl) {
63*6236dae4SAndroid Build Coastguard Worker    struct curl_slist *list;
64*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
65*6236dae4SAndroid Build Coastguard Worker
66*6236dae4SAndroid Build Coastguard Worker    list = curl_slist_append(NULL, "ICY 200 OK");
67*6236dae4SAndroid Build Coastguard Worker    list = curl_slist_append(list, "WEIRDO 99 FINE");
68*6236dae4SAndroid Build Coastguard Worker
69*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_HTTP200ALIASES, list);
70*6236dae4SAndroid Build Coastguard Worker    curl_easy_perform(curl);
71*6236dae4SAndroid Build Coastguard Worker    curl_slist_free_all(list); /* free the list again */
72*6236dae4SAndroid Build Coastguard Worker  }
73*6236dae4SAndroid Build Coastguard Worker}
74*6236dae4SAndroid Build Coastguard Worker~~~
75*6236dae4SAndroid Build Coastguard Worker
76*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
77*6236dae4SAndroid Build Coastguard Worker
78*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
79*6236dae4SAndroid Build Coastguard Worker
80*6236dae4SAndroid Build Coastguard WorkerReturns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
81