Return to CURLOPT_HTTP200ALIASES.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_HTTP200ALIASES.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, 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_HTTP200ALIASES 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_HTTP200ALIASES \- specify alternative matches for HTTP 200 OK
                     27: .SH SYNOPSIS
                     28: .nf
                     29: #include <curl/curl.h>
                     30: 
                     31: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTP200ALIASES,
                     32:                           struct curl_slist *aliases);
                     33: .SH DESCRIPTION
                     34: Pass a pointer to a linked list of \fIaliases\fP to be treated as valid HTTP
                     35: 200 responses.  Some servers respond with a custom header response line.  For
                     36: example, SHOUTcast servers respond with "ICY 200 OK". Also some very old
                     37: Icecast 1.3.x servers will respond like that for certain user agent headers or
                     38: in absence of such. By including this string in your list of aliases,
                     39: the response will be treated as a valid HTTP header line such as
                     40: "HTTP/1.0 200 OK".
                     41: 
                     42: The linked list should be a fully valid list of struct curl_slist structs, and
                     43: be properly filled in.  Use \fIcurl_slist_append(3)\fP to create the list and
                     44: \fIcurl_slist_free_all(3)\fP to clean up an entire list.
                     45: 
                     46: The alias itself is not parsed for any version strings. The protocol is
                     47: assumed to match HTTP 1.0 when an alias match.
                     48: .SH DEFAULT
                     49: NULL
                     50: .SH PROTOCOLS
                     51: HTTP
                     52: .SH EXAMPLE
                     53: .nf
                     54: CURL *curl = curl_easy_init();
                     55: if(curl) {
                     56:   struct curl_slist *list;
                     57:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
                     58: 
                     59:   list = curl_slist_append(NULL, "ICY 200 OK");
                     60:   list = curl_slist_append(list, "WEIRDO 99 FINE");
                     61: 
                     62:   curl_easy_setopt(curl, CURLOPT_HTTP200ALIASES, list);
                     63:   curl_easy_perform(curl);
                     64:   curl_slist_free_all(list); /* free the list again */
                     65: }
                     66: .fi
                     67: .SH AVAILABILITY
                     68: Added in 7.10.3
                     69: .SH RETURN VALUE
                     70: Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
                     71: .SH "SEE ALSO"
                     72: .BR CURLOPT_HTTP_VERSION "(3), "