gio/gtlsbackend.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2010 Red Hat, Inc.
   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
  21 #ifndef __G_TLS_BACKEND_H__
  22 #define __G_TLS_BACKEND_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 /**
  33  * G_TLS_BACKEND_EXTENSION_POINT_NAME:
  34  *
  35  * Extension point for TLS functionality via #GTlsBackend.
  36  * See <link linkend="extending-gio">Extending GIO</link>.
  37  */
  38 #define G_TLS_BACKEND_EXTENSION_POINT_NAME "gio-tls-backend"
  39
  40 #define G_TYPE_TLS_BACKEND               (g_tls_backend_get_type ())
  41 #define G_TLS_BACKEND(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_TLS_BACKEND, GTlsBackend))
  42 #define G_IS_TLS_BACKEND(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_TLS_BACKEND))
  43 #define G_TLS_BACKEND_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_TLS_BACKEND, GTlsBackendInterface))
  44
  45 typedef struct _GTlsBackend          GTlsBackend;
  46 typedef struct _GTlsBackendInterface GTlsBackendInterface;
  47
  48 /**
  49  * GTlsBackendInterface:
  50  * @g_iface: The parent interface.
  51  * @supports_tls: returns whether the backend supports TLS.
  52  * @get_default_database: returns a default #GTlsDatabase instance.
  53  * @get_certificate_type: returns the #GTlsCertificate implementation type
  54  * @get_client_connection_type: returns the #GTlsClientConnection implementation type
  55  * @get_server_connection_type: returns the #GTlsServerConnection implementation type
  56  * @get_file_database_type: returns the #GTlsFileDatabase implementation type.
  57  *
  58  * Provides an interface for describing TLS-related types.
  59  *
  60  * Since: 2.28
  61  */
  62 struct _GTlsBackendInterface
  63 {
  64   GTypeInterface g_iface;
  65
  66   /* methods */
  67   gboolean       ( *supports_tls)               (GTlsBackend *backend);
  68   GType          ( *get_certificate_type)       (void);
  69   GType          ( *get_client_connection_type) (void);
  70   GType          ( *get_server_connection_type) (void);
  71   GType          ( *get_file_database_type)     (void);
  72   GTlsDatabase * ( *get_default_database)       (GTlsBackend *backend);
  73 };
  74
  75 GLIB_AVAILABLE_IN_ALL
  76 GType          g_tls_backend_get_type                   (void) G_GNUC_CONST;
  77
  78 GLIB_AVAILABLE_IN_ALL
  79 GTlsBackend *  g_tls_backend_get_default                (void);
  80
  81 GLIB_AVAILABLE_IN_ALL
  82 GTlsDatabase * g_tls_backend_get_default_database       (GTlsBackend *backend);
  83
  84 GLIB_AVAILABLE_IN_ALL
  85 gboolean       g_tls_backend_supports_tls               (GTlsBackend *backend);
  86
  87 GLIB_AVAILABLE_IN_ALL
  88 GType          g_tls_backend_get_certificate_type       (GTlsBackend *backend);
  89 GLIB_AVAILABLE_IN_ALL
  90 GType          g_tls_backend_get_client_connection_type (GTlsBackend *backend);
  91 GLIB_AVAILABLE_IN_ALL
  92 GType          g_tls_backend_get_server_connection_type (GTlsBackend *backend);
  93 GLIB_AVAILABLE_IN_ALL
  94 GType          g_tls_backend_get_file_database_type     (GTlsBackend *backend);
  95
  96 G_END_DECLS
  97
  98 #endif /* __G_TLS_BACKEND_H__ */