1 /* libquvi 2 * Copyright (C) 2012,2013 Toni Gundogdu <legatvs@gmail.com> 3 * 4 * This file is part of libquvi <http://quvi.sourceforge.net/>. 5 * 6 * This library is free software: you can redistribute it and/or 7 * modify it under the terms of the GNU Affero General Public 8 * License as published by the Free Software Foundation, either 9 * version 3 of the License, or (at your option) any later version. 10 * 11 * This library is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU Affero General Public License for more details. 15 * 16 * You should have received a copy of the GNU Affero General 17 * Public License along with this library. If not, see 18 * <http://www.gnu.org/licenses/>. 19 */ 20 21 #ifndef qoption_h 22 #define qoption_h 23 24 /** @file qoption.h */ 25 26 /** @enum QuviOption 27 @brief Options to be used with @ref quvi_set */ 28 typedef enum 29 { 30 /** Default: None */ 31 QUVI_OPTION_CALLBACK_STATUS, 32 /** Default: None */ 33 QUVI_OPTION_CALLBACK_STATUS_USERDATA, 34 /** Enable cookies for libcurl handle. 35 * Default: QUVI_FALSE. When enabled (QUVI_TRUE), libcurl will 36 * parse the received cookies and use them in the subsequent HTTP 37 * requests. 38 * @note 39 * When disabled, quvi.http.cookie (of the quvi-object(7)) is also 40 * disabled 41 * @sa 42 * http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTCOOKIEFILE 43 * @sa 44 * http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTCOOKIELIST 45 * @sa 46 * http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTCOOKIEJAR 47 */ 48 QUVI_OPTION_ALLOW_COOKIES, 49 /** Identify as the user-agent to the HTTP servers. 50 * Default: "Mozilla/5.0". 51 * @note 52 * libquvi scripts may override this setting at any time. The 53 * original value set using this option will be restored each time 54 * the network accessing functions are called, e.g. 55 * quvi.http.fetch 56 * @sa http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTUSERAGENT 57 */ 58 QUVI_OPTION_USER_AGENT, 59 /** Autodetect and set the proxy for new connections. 60 * Default: QUVI_FALSE. When enabled (QUVI_TRUE), libquvi uses libproxy 61 * to detect the system proxy settings and sets the CURLOPT_PROXY to the 62 * libproxy returned value. This is done for each new connection. 63 * @sa http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTPROXY 64 * @sa http://libproxy.googlecode.com/ 65 */ 66 QUVI_OPTION_AUTOPROXY 67 } QuviOption; 68 69 #endif /* qoption_h */ 70 71 /* vim: set ts=2 sw=2 tw=72 expandtab: */ 72