gio/gproxyresolver.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2010 Collabora, Ltd.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Nicolas Dufresne <nicolas.dufresne@collabora.co.uk>
  21  */
  22
  23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __G_PROXY_RESOLVER_H__
  28 #define __G_PROXY_RESOLVER_H__
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_PROXY_RESOLVER         (g_proxy_resolver_get_type ())
  35 #define G_PROXY_RESOLVER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_PROXY_RESOLVER, GProxyResolver))
  36 #define G_IS_PROXY_RESOLVER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_PROXY_RESOLVER))
  37 #define G_PROXY_RESOLVER_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), G_TYPE_PROXY_RESOLVER, GProxyResolverInterface))
  38
  39 /**
  40  * G_PROXY_RESOLVER_EXTENSION_POINT_NAME:
  41  *
  42  * Extension point for proxy resolving functionality.
  43  * See <link linkend="extending-gio">Extending GIO</link>.
  44  */
  45 #define G_PROXY_RESOLVER_EXTENSION_POINT_NAME "gio-proxy-resolver"
  46
  47 /**
  48  * GProxyResolver:
  49  *
  50  * Interface that can be used to resolve proxy address.
  51  */
  52 typedef struct _GProxyResolverInterface GProxyResolverInterface;
  53
  54 struct _GProxyResolverInterface {
  55   GTypeInterface g_iface;
  56
  57   /* Virtual Table */
  58   gboolean (* is_supported)  (GProxyResolver       *resolver);
  59
  60   gchar ** (* lookup)        (GProxyResolver       *resolver,
  61                               const gchar          *uri,
  62                               GCancellable         *cancellable,
  63                               GError              **error);
  64
  65   void     (* lookup_async)  (GProxyResolver       *resolver,
  66                               const gchar          *uri,
  67                               GCancellable         *cancellable,
  68                               GAsyncReadyCallback   callback,
  69                               gpointer              user_data);
  70
  71   gchar ** (* lookup_finish) (GProxyResolver       *resolver,
  72                               GAsyncResult         *result,
  73                               GError              **error);
  74 };
  75
  76 GType           g_proxy_resolver_get_type       (void) G_GNUC_CONST;
  77 GProxyResolver *g_proxy_resolver_get_default    (void);
  78
  79 gboolean        g_proxy_resolver_is_supported   (GProxyResolver       *resolver);
  80 gchar         **g_proxy_resolver_lookup         (GProxyResolver       *resolver,
  81                                                  const gchar          *uri,
  82                                                  GCancellable         *cancellable,
  83                                                  GError              **error);
  84 void            g_proxy_resolver_lookup_async   (GProxyResolver       *resolver,
  85                                                  const gchar          *uri,
  86                                                  GCancellable         *cancellable,
  87                                                  GAsyncReadyCallback   callback,
  88                                                  gpointer              user_data);
  89 gchar         **g_proxy_resolver_lookup_finish  (GProxyResolver       *resolver,
  90                                                  GAsyncResult         *result,
  91                                                  GError              **error);
  92
  93
  94 G_END_DECLS
  95
  96 #endif /* __G_PROXY_RESOLVER_H__ */