gproxyresolver.h

Go to the documentation of this file.

/* GIO - GLib Input, Output and Streaming Library
 *
 * Copyright (C) 2010 Collabora, Ltd.
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Nicolas Dufresne <nicolas.dufresne@collabora.co.uk>
 */
 
#ifndef __G_PROXY_RESOLVER_H__
#define __G_PROXY_RESOLVER_H__
 
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif
 
#include <gio/giotypes.h>
 
G_BEGIN_DECLS
 
#define G_TYPE_PROXY_RESOLVER         (g_proxy_resolver_get_type ())
#define G_PROXY_RESOLVER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_PROXY_RESOLVER, GProxyResolver))
#define G_IS_PROXY_RESOLVER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_PROXY_RESOLVER))
#define G_PROXY_RESOLVER_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), G_TYPE_PROXY_RESOLVER, GProxyResolverInterface))
 
/**
 * G_PROXY_RESOLVER_EXTENSION_POINT_NAME:
 *
 * Extension point for proxy resolving functionality.
 * See [Extending GIO][extending-gio].
 */
#define G_PROXY_RESOLVER_EXTENSION_POINT_NAME "gio-proxy-resolver"
 
typedef struct _GProxyResolverInterface GProxyResolverInterface;
 
struct _GProxyResolverInterface {
  GTypeInterface g_iface;
 
  /* Virtual Table */
  gboolean (* is_supported)  (GProxyResolver       *resolver);
 
  gchar ** (* lookup)        (GProxyResolver       *resolver,
                  const gchar          *uri,
                  GCancellable         *cancellable,
                  GError              **error);
 
  void     (* lookup_async)  (GProxyResolver       *resolver,
                  const gchar          *uri,
                  GCancellable         *cancellable,
                  GAsyncReadyCallback   callback,
                  gpointer              user_data);
 
  gchar ** (* lookup_finish) (GProxyResolver       *resolver,
                  GAsyncResult         *result,
                  GError              **error);
};
 
GIO_AVAILABLE_IN_ALL
GType       g_proxy_resolver_get_type       (void) G_GNUC_CONST;
GIO_AVAILABLE_IN_ALL
GProxyResolver *g_proxy_resolver_get_default    (void);
 
GIO_AVAILABLE_IN_ALL
gboolean        g_proxy_resolver_is_supported   (GProxyResolver       *resolver);
GIO_AVAILABLE_IN_ALL
gchar         **g_proxy_resolver_lookup     (GProxyResolver       *resolver,
                         const gchar          *uri,
                         GCancellable         *cancellable,
                         GError              **error);
GIO_AVAILABLE_IN_ALL
void        g_proxy_resolver_lookup_async   (GProxyResolver       *resolver,
                         const gchar          *uri,
                         GCancellable         *cancellable,
                         GAsyncReadyCallback   callback,
                         gpointer              user_data);
GIO_AVAILABLE_IN_ALL
gchar         **g_proxy_resolver_lookup_finish  (GProxyResolver       *resolver,
                         GAsyncResult         *result,
                         GError              **error);
 
 
G_END_DECLS
 
#endif /* __G_PROXY_RESOLVER_H__ */