lib/url.h

   1 #ifndef __URL_H
   2 #define __URL_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 1998 - 2010, Daniel Stenberg, <daniel@haxx.se>, et al.
  11  *
  12  * This software is licensed as described in the file COPYING, which
  13  * you should have received as part of this distribution. The terms
  14  * are also available at http://curl.haxx.se/docs/copyright.html.
  15  *
  16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17  * copies of the Software, and permit persons to whom the Software is
  18  * furnished to do so, under the terms of the COPYING file.
  19  *
  20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21  * KIND, either express or implied.
  22  *
  23  ***************************************************************************/
  24
  25 #include <stdarg.h> /* to make sure we have ap_list */
  26
  27 /*
  28  * Prototypes for library-wide functions provided by url.c
  29  */
  30
  31 CURLcode Curl_open(struct SessionHandle **curl);
  32 CURLcode Curl_init_userdefined(struct UserDefined *set);
  33 CURLcode Curl_setopt(struct SessionHandle *data, CURLoption option,
  34                      va_list arg);
  35 CURLcode Curl_dupset(struct SessionHandle * dst, struct SessionHandle * src);
  36 void Curl_freeset(struct SessionHandle * data);
  37 CURLcode Curl_close(struct SessionHandle *data); /* opposite of curl_open() */
  38 CURLcode Curl_connect(struct SessionHandle *, struct connectdata **,
  39                       bool *async, bool *protocol_connect);
  40 CURLcode Curl_async_resolved(struct connectdata *conn,
  41                              bool *protocol_connect);
  42 CURLcode Curl_do(struct connectdata **, bool *done);
  43 CURLcode Curl_do_more(struct connectdata *);
  44 CURLcode Curl_done(struct connectdata **, CURLcode, bool premature);
  45 CURLcode Curl_disconnect(struct connectdata *, bool dead_connection);
  46 CURLcode Curl_protocol_connect(struct connectdata *conn, bool *done);
  47 CURLcode Curl_protocol_connecting(struct connectdata *conn, bool *done);
  48 CURLcode Curl_protocol_doing(struct connectdata *conn, bool *done);
  49 void Curl_safefree(void *ptr);
  50
  51 /* create a connection cache */
  52 struct conncache *Curl_mk_connc(int type, long amount);
  53 /* free a connection cache */
  54 void Curl_rm_connc(struct conncache *c);
  55 /* Change number of entries of a connection cache */
  56 CURLcode Curl_ch_connc(struct SessionHandle *data,
  57                        struct conncache *c,
  58                        long newamount);
  59
  60 int Curl_protocol_getsock(struct connectdata *conn,
  61                           curl_socket_t *socks,
  62                           int numsocks);
  63 int Curl_doing_getsock(struct connectdata *conn,
  64                        curl_socket_t *socks,
  65                        int numsocks);
  66
  67 bool Curl_isPipeliningEnabled(const struct SessionHandle *handle);
  68 CURLcode Curl_addHandleToPipeline(struct SessionHandle *handle,
  69                                   struct curl_llist *pipeline);
  70 int Curl_removeHandleFromPipeline(struct SessionHandle *handle,
  71                                   struct curl_llist *pipeline);
  72 /* remove the specified connection from all (possible) pipelines and related
  73    queues */
  74 void Curl_getoff_all_pipelines(struct SessionHandle *data,
  75                                struct connectdata *conn);
  76
  77 void Curl_close_connections(struct SessionHandle *data);
  78
  79 /* Called on connect, and if there's already a protocol-specific struct
  80    allocated for a different connection, this frees it that it can be setup
  81    properly later on. */
  82 void Curl_reset_reqproto(struct connectdata *conn);
  83
  84 #define CURL_DEFAULT_PROXY_PORT 1080 /* default proxy port unless specified */
  85 #define CURL_DEFAULT_SOCKS5_GSSAPI_SERVICE "rcmd" /* default socks5 gssapi service */
  86
  87 CURLcode Curl_connected_proxy(struct connectdata *conn);
  88
  89 #ifdef CURL_DISABLE_VERBOSE_STRINGS
  90 #define Curl_verboseconnect(x)  do { } while (0)
  91 #else
  92 void Curl_verboseconnect(struct connectdata *conn);
  93 #endif
  94
  95
  96 #endif