libsoup/soup-session.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2000-2003, Ximian, Inc.
   4  */
   5
   6 #ifndef SOUP_SESSION_H
   7 #define SOUP_SESSION_H 1
   8
   9 #include <libsoup/soup-types.h>
  10 #include <libsoup/soup-address.h>
  11 #include <libsoup/soup-message.h>
  12
  13 G_BEGIN_DECLS
  14
  15 #define SOUP_TYPE_SESSION            (soup_session_get_type ())
  16 #define SOUP_SESSION(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), SOUP_TYPE_SESSION, SoupSession))
  17 #define SOUP_SESSION_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), SOUP_TYPE_SESSION, SoupSessionClass))
  18 #define SOUP_IS_SESSION(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SOUP_TYPE_SESSION))
  19 #define SOUP_IS_SESSION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), SOUP_TYPE_SESSION))
  20 #define SOUP_SESSION_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), SOUP_TYPE_SESSION, SoupSessionClass))
  21
  22 typedef void (*SoupSessionCallback) (SoupSession           *session,
  23                                      SoupMessage           *msg,
  24                                      gpointer               user_data);
  25
  26 struct _SoupSession {
  27         GObject parent;
  28
  29 };
  30
  31 typedef struct {
  32         GObjectClass parent_class;
  33
  34         /* signals */
  35         void (*request_started) (SoupSession *session, SoupMessage *msg,
  36                                  SoupSocket *socket);
  37         void (*authenticate)    (SoupSession *session, SoupMessage *msg,
  38                                  SoupAuth *auth, gboolean retrying);
  39
  40         /* methods */
  41         void  (*queue_message)   (SoupSession *session, SoupMessage *msg,
  42                                   SoupSessionCallback callback,
  43                                   gpointer user_data);
  44         void  (*requeue_message) (SoupSession *session, SoupMessage *msg);
  45         guint (*send_message)    (SoupSession *session, SoupMessage *msg);
  46
  47         void  (*cancel_message)  (SoupSession *session, SoupMessage *msg,
  48                                   guint status_code);
  49
  50         void  (*auth_required)   (SoupSession *session, SoupMessage *msg,
  51                                   SoupAuth *auth, gboolean retrying);
  52
  53         void  (*flush_queue)     (SoupSession *session);
  54
  55         void  (*kick)            (SoupSession *session);
  56
  57         /* Padding for future expansion */
  58         void (*_libsoup_reserved4) (void);
  59 } SoupSessionClass;
  60
  61 GType soup_session_get_type (void);
  62
  63 #define SOUP_SESSION_PROXY_URI              "proxy-uri"
  64 #define SOUP_SESSION_MAX_CONNS              "max-conns"
  65 #define SOUP_SESSION_MAX_CONNS_PER_HOST     "max-conns-per-host"
  66 #define SOUP_SESSION_USE_NTLM               "use-ntlm"
  67 #define SOUP_SESSION_SSL_CA_FILE            "ssl-ca-file"
  68 #define SOUP_SESSION_SSL_USE_SYSTEM_CA_FILE "ssl-use-system-ca-file"
  69 #define SOUP_SESSION_TLS_DATABASE           "tls-database"
  70 #define SOUP_SESSION_SSL_STRICT             "ssl-strict"
  71 #define SOUP_SESSION_ASYNC_CONTEXT          "async-context"
  72 #define SOUP_SESSION_USE_THREAD_CONTEXT     "use-thread-context"
  73 #define SOUP_SESSION_TIMEOUT                "timeout"
  74 #define SOUP_SESSION_USER_AGENT             "user-agent"
  75 #define SOUP_SESSION_ACCEPT_LANGUAGE        "accept-language"
  76 #define SOUP_SESSION_ACCEPT_LANGUAGE_AUTO   "accept-language-auto"
  77 #define SOUP_SESSION_IDLE_TIMEOUT           "idle-timeout"
  78 #define SOUP_SESSION_ADD_FEATURE            "add-feature"
  79 #define SOUP_SESSION_ADD_FEATURE_BY_TYPE    "add-feature-by-type"
  80 #define SOUP_SESSION_REMOVE_FEATURE_BY_TYPE "remove-feature-by-type"
  81 #define SOUP_SESSION_HTTP_ALIASES       "http-aliases"
  82 #define SOUP_SESSION_HTTPS_ALIASES      "https-aliases"
  83
  84 SOUP_AVAILABLE_IN_2_42
  85 SoupSession    *soup_session_new              (void);
  86
  87 SOUP_AVAILABLE_IN_2_42
  88 SoupSession    *soup_session_new_with_options (const char *optname1,
  89                                                ...) G_GNUC_NULL_TERMINATED;
  90
  91 void            soup_session_queue_message    (SoupSession           *session,
  92                                                SoupMessage           *msg,
  93                                                SoupSessionCallback    callback,
  94                                                gpointer               user_data);
  95 void            soup_session_requeue_message  (SoupSession           *session,
  96                                                SoupMessage           *msg);
  97
  98 guint           soup_session_send_message     (SoupSession           *session,
  99                                                SoupMessage           *msg);
 100
 101 void            soup_session_pause_message    (SoupSession           *session,
 102                                                SoupMessage           *msg);
 103 void            soup_session_unpause_message  (SoupSession           *session,
 104                                                SoupMessage           *msg);
 105
 106 void            soup_session_cancel_message   (SoupSession           *session,
 107                                                SoupMessage           *msg,
 108                                                guint                  status_code);
 109 void            soup_session_abort            (SoupSession           *session);
 110
 111 GMainContext   *soup_session_get_async_context(SoupSession           *session);
 112
 113 #ifndef LIBSOUP_DISABLE_DEPRECATED
 114 /* SOUP_AVAILABLE_IN_2_30 -- this trips up gtkdoc-scan */
 115 SOUP_DEPRECATED_IN_2_38_FOR (soup_session_prefetch_dns)
 116 void            soup_session_prepare_for_uri  (SoupSession           *session,
 117                                                SoupURI               *uri);
 118 #endif
 119
 120 SOUP_AVAILABLE_IN_2_38
 121 void            soup_session_prefetch_dns     (SoupSession           *session,
 122                                                const char            *hostname,
 123                                                GCancellable          *cancellable,
 124                                                SoupAddressCallback    callback,
 125                                                gpointer               user_data);
 126
 127 SOUP_AVAILABLE_IN_2_38
 128 gboolean        soup_session_would_redirect   (SoupSession           *session,
 129                                                SoupMessage           *msg);
 130 SOUP_AVAILABLE_IN_2_38
 131 gboolean        soup_session_redirect_message (SoupSession           *session,
 132                                                SoupMessage           *msg);
 133
 134 SOUP_AVAILABLE_IN_2_24
 135 void                soup_session_add_feature            (SoupSession        *session,
 136                                                          SoupSessionFeature *feature);
 137 SOUP_AVAILABLE_IN_2_24
 138 void                soup_session_add_feature_by_type    (SoupSession        *session,
 139                                                          GType               feature_type);
 140 SOUP_AVAILABLE_IN_2_24
 141 void                soup_session_remove_feature         (SoupSession        *session,
 142                                                          SoupSessionFeature *feature);
 143 SOUP_AVAILABLE_IN_2_24
 144 void                soup_session_remove_feature_by_type (SoupSession        *session,
 145                                                          GType               feature_type);
 146 SOUP_AVAILABLE_IN_2_42
 147 gboolean            soup_session_has_feature            (SoupSession        *session,
 148                                                          GType               feature_type);
 149 SOUP_AVAILABLE_IN_2_26
 150 GSList             *soup_session_get_features           (SoupSession        *session,
 151                                                          GType               feature_type);
 152 SOUP_AVAILABLE_IN_2_26
 153 SoupSessionFeature *soup_session_get_feature            (SoupSession        *session,
 154                                                          GType               feature_type);
 155 SOUP_AVAILABLE_IN_2_28
 156 SoupSessionFeature *soup_session_get_feature_for_message(SoupSession        *session,
 157                                                          GType               feature_type,
 158                                                          SoupMessage        *msg);
 159
 160 SOUP_AVAILABLE_IN_2_42
 161 SoupRequest     *soup_session_request          (SoupSession  *session,
 162                                                 const char   *uri_string,
 163                                                 GError      **error);
 164 SOUP_AVAILABLE_IN_2_42
 165 SoupRequest     *soup_session_request_uri      (SoupSession  *session,
 166                                                 SoupURI      *uri,
 167                                                 GError      **error);
 168 SOUP_AVAILABLE_IN_2_42
 169 SoupRequestHTTP *soup_session_request_http     (SoupSession  *session,
 170                                                 const char   *method,
 171                                                 const char   *uri_string,
 172                                                 GError      **error);
 173 SOUP_AVAILABLE_IN_2_42
 174 SoupRequestHTTP *soup_session_request_http_uri (SoupSession  *session,
 175                                                 const char   *method,
 176                                                 SoupURI      *uri,
 177                                                 GError      **error);
 178
 179 SOUP_AVAILABLE_IN_2_42
 180 GQuark soup_request_error_quark (void);
 181 #define SOUP_REQUEST_ERROR soup_request_error_quark ()
 182
 183 typedef enum {
 184         SOUP_REQUEST_ERROR_BAD_URI,
 185         SOUP_REQUEST_ERROR_UNSUPPORTED_URI_SCHEME,
 186         SOUP_REQUEST_ERROR_PARSING,
 187         SOUP_REQUEST_ERROR_ENCODING
 188 } SoupRequestError;
 189
 190 G_END_DECLS
 191
 192 #endif /* SOUP_SESSION_H */