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-message.h>
  11
  12 G_BEGIN_DECLS
  13
  14 #define SOUP_TYPE_SESSION            (soup_session_get_type ())
  15 #define SOUP_SESSION(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), SOUP_TYPE_SESSION, SoupSession))
  16 #define SOUP_SESSION_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), SOUP_TYPE_SESSION, SoupSessionClass))
  17 #define SOUP_IS_SESSION(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SOUP_TYPE_SESSION))
  18 #define SOUP_IS_SESSION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), SOUP_TYPE_SESSION))
  19 #define SOUP_SESSION_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), SOUP_TYPE_SESSION, SoupSessionClass))
  20
  21 typedef void (*SoupSessionCallback) (SoupSession           *session,
  22                                      SoupMessage           *msg,
  23                                      gpointer               user_data);
  24
  25 struct _SoupSession {
  26         GObject parent;
  27
  28 };
  29
  30 typedef struct {
  31         GObjectClass parent_class;
  32
  33         /* signals */
  34         void (*request_started) (SoupSession *session, SoupMessage *msg,
  35                                  SoupSocket *socket);
  36         void (*authenticate)    (SoupSession *session, SoupMessage *msg,
  37                                  SoupAuth *auth, gboolean retrying);
  38
  39         /* methods */
  40         void  (*queue_message)   (SoupSession *session, SoupMessage *msg,
  41                                   SoupSessionCallback callback,
  42                                   gpointer user_data);
  43         void  (*requeue_message) (SoupSession *session, SoupMessage *msg);
  44         guint (*send_message)    (SoupSession *session, SoupMessage *msg);
  45
  46         void  (*cancel_message)  (SoupSession *session, SoupMessage *msg,
  47                                   guint status_code);
  48
  49         void  (*auth_required)   (SoupSession *session, SoupMessage *msg,
  50                                   SoupAuth *auth, gboolean retrying);
  51
  52         void  (*flush_queue)     (SoupSession *session);
  53
  54         /* Padding for future expansion */
  55         void (*_libsoup_reserved3) (void);
  56         void (*_libsoup_reserved4) (void);
  57 } SoupSessionClass;
  58
  59 GType soup_session_get_type (void);
  60
  61 #define SOUP_SESSION_PROXY_URI              "proxy-uri"
  62 #define SOUP_SESSION_MAX_CONNS              "max-conns"
  63 #define SOUP_SESSION_MAX_CONNS_PER_HOST     "max-conns-per-host"
  64 #define SOUP_SESSION_USE_NTLM               "use-ntlm"
  65 #define SOUP_SESSION_SSL_CA_FILE            "ssl-ca-file"
  66 #define SOUP_SESSION_SSL_STRICT             "ssl-strict"
  67 #define SOUP_SESSION_ASYNC_CONTEXT          "async-context"
  68 #define SOUP_SESSION_TIMEOUT                "timeout"
  69 #define SOUP_SESSION_USER_AGENT             "user-agent"
  70 #define SOUP_SESSION_ACCEPT_LANGUAGE        "accept-language"
  71 #define SOUP_SESSION_ACCEPT_LANGUAGE_AUTO   "accept-language-auto"
  72 #define SOUP_SESSION_IDLE_TIMEOUT           "idle-timeout"
  73 #define SOUP_SESSION_ADD_FEATURE            "add-feature"
  74 #define SOUP_SESSION_ADD_FEATURE_BY_TYPE    "add-feature-by-type"
  75 #define SOUP_SESSION_REMOVE_FEATURE_BY_TYPE "remove-feature-by-type"
  76
  77 GMainContext   *soup_session_get_async_context(SoupSession           *session);
  78
  79 void            soup_session_queue_message    (SoupSession           *session,
  80                                                SoupMessage           *msg,
  81                                                SoupSessionCallback    callback,
  82                                                gpointer               user_data);
  83 void            soup_session_requeue_message  (SoupSession           *session,
  84                                                SoupMessage           *msg);
  85
  86 guint           soup_session_send_message     (SoupSession           *session,
  87                                                SoupMessage           *msg);
  88
  89 void            soup_session_pause_message    (SoupSession           *session,
  90                                                SoupMessage           *msg);
  91 void            soup_session_unpause_message  (SoupSession           *session,
  92                                                SoupMessage           *msg);
  93
  94 void            soup_session_cancel_message   (SoupSession           *session,
  95                                                SoupMessage           *msg,
  96                                                guint                  status_code);
  97 void            soup_session_abort            (SoupSession           *session);
  98
  99 void            soup_session_prepare_for_uri  (SoupSession           *session,
 100                                                SoupURI               *uri);
 101
 102 void                soup_session_add_feature            (SoupSession        *session,
 103                                                          SoupSessionFeature *feature);
 104 void                soup_session_add_feature_by_type    (SoupSession        *session,
 105                                                          GType               feature_type);
 106 void                soup_session_remove_feature         (SoupSession        *session,
 107                                                          SoupSessionFeature *feature);
 108 void                soup_session_remove_feature_by_type (SoupSession        *session,
 109                                                          GType               feature_type);
 110 GSList             *soup_session_get_features           (SoupSession        *session,
 111                                                          GType               feature_type);
 112 SoupSessionFeature *soup_session_get_feature            (SoupSession        *session,
 113                                                          GType               feature_type);
 114 SoupSessionFeature *soup_session_get_feature_for_message(SoupSession        *session,
 115                                                          GType               feature_type,
 116                                                          SoupMessage        *msg);
 117
 118 G_END_DECLS
 119
 120 #endif /* SOUP_SESSION_H */