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.1 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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Nicolas Dufresne <nicolas.dufresne@collabora.co.uk>
  19  */
  20
  21 #ifndef __G_PROXY_RESOLVER_H__
  22 #define __G_PROXY_RESOLVER_H__
  23
  24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25 #error "Only <gio/gio.h> can be included directly."
  26 #endif
  27
  28 #include <gio/giotypes.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_TYPE_PROXY_RESOLVER         (g_proxy_resolver_get_type ())
  33 #define G_PROXY_RESOLVER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_PROXY_RESOLVER, GProxyResolver))
  34 #define G_IS_PROXY_RESOLVER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_PROXY_RESOLVER))
  35 #define G_PROXY_RESOLVER_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), G_TYPE_PROXY_RESOLVER, GProxyResolverInterface))
  36
  37 /**
  38  * G_PROXY_RESOLVER_EXTENSION_POINT_NAME:
  39  *
  40  * Extension point for proxy resolving functionality.
  41  * See [Extending GIO][extending-gio].
  42  */
  43 #define G_PROXY_RESOLVER_EXTENSION_POINT_NAME "gio-proxy-resolver"
  44
  45 typedef struct _GProxyResolverInterface GProxyResolverInterface;
  46
  47 struct _GProxyResolverInterface {
  48   GTypeInterface g_iface;
  49
  50   /* Virtual Table */
  51   gboolean (* is_supported)  (GProxyResolver       *resolver);
  52
  53   gchar ** (* lookup)        (GProxyResolver       *resolver,
  54                               const gchar          *uri,
  55                               GCancellable         *cancellable,
  56                               GError              **error);
  57
  58   void     (* lookup_async)  (GProxyResolver       *resolver,
  59                               const gchar          *uri,
  60                               GCancellable         *cancellable,
  61                               GAsyncReadyCallback   callback,
  62                               gpointer              user_data);
  63
  64   gchar ** (* lookup_finish) (GProxyResolver       *resolver,
  65                               GAsyncResult         *result,
  66                               GError              **error);
  67 };
  68
  69 GLIB_AVAILABLE_IN_ALL
  70 GType           g_proxy_resolver_get_type       (void) G_GNUC_CONST;
  71 GLIB_AVAILABLE_IN_ALL
  72 GProxyResolver *g_proxy_resolver_get_default    (void);
  73
  74 GLIB_AVAILABLE_IN_ALL
  75 gboolean        g_proxy_resolver_is_supported   (GProxyResolver       *resolver);
  76 GLIB_AVAILABLE_IN_ALL
  77 gchar         **g_proxy_resolver_lookup         (GProxyResolver       *resolver,
  78                                                  const gchar          *uri,
  79                                                  GCancellable         *cancellable,
  80                                                  GError              **error);
  81 GLIB_AVAILABLE_IN_ALL
  82 void            g_proxy_resolver_lookup_async   (GProxyResolver       *resolver,
  83                                                  const gchar          *uri,
  84                                                  GCancellable         *cancellable,
  85                                                  GAsyncReadyCallback   callback,
  86                                                  gpointer              user_data);
  87 GLIB_AVAILABLE_IN_ALL
  88 gchar         **g_proxy_resolver_lookup_finish  (GProxyResolver       *resolver,
  89                                                  GAsyncResult         *result,
  90                                                  GError              **error);
  91
  92
  93 G_END_DECLS
  94
  95 #endif /* __G_PROXY_RESOLVER_H__ */