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, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef __G_TLS_BACKEND_H__
  20 #define __G_TLS_BACKEND_H__
  21
  22 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  23 #error "Only <gio/gio.h> can be included directly."
  24 #endif
  25
  26 #include <gio/giotypes.h>
  27
  28 G_BEGIN_DECLS
  29
  30 /**
  31  * G_TLS_BACKEND_EXTENSION_POINT_NAME:
  32  *
  33  * Extension point for TLS functionality via #GTlsBackend.
  34  * See [Extending GIO][extending-gio].
  35  */
  36 #define G_TLS_BACKEND_EXTENSION_POINT_NAME "gio-tls-backend"
  37
  38 #define G_TYPE_TLS_BACKEND               (g_tls_backend_get_type ())
  39 #define G_TLS_BACKEND(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_TLS_BACKEND, GTlsBackend))
  40 #define G_IS_TLS_BACKEND(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_TLS_BACKEND))
  41 #define G_TLS_BACKEND_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_TLS_BACKEND, GTlsBackendInterface))
  42
  43 typedef struct _GTlsBackend          GTlsBackend;
  44 typedef struct _GTlsBackendInterface GTlsBackendInterface;
  45
  46 /**
  47  * GTlsBackendInterface:
  48  * @g_iface: The parent interface.
  49  * @supports_tls: returns whether the backend supports TLS.
  50  * @get_default_database: returns a default #GTlsDatabase instance.
  51  * @get_certificate_type: returns the #GTlsCertificate implementation type
  52  * @get_client_connection_type: returns the #GTlsClientConnection implementation type
  53  * @get_server_connection_type: returns the #GTlsServerConnection implementation type
  54  * @get_file_database_type: returns the #GTlsFileDatabase implementation type.
  55  *
  56  * Provides an interface for describing TLS-related types.
  57  *
  58  * Since: 2.28
  59  */
  60 struct _GTlsBackendInterface
  61 {
  62   GTypeInterface g_iface;
  63
  64   /* methods */
  65   gboolean       ( *supports_tls)               (GTlsBackend *backend);
  66   GType          ( *get_certificate_type)       (void);
  67   GType          ( *get_client_connection_type) (void);
  68   GType          ( *get_server_connection_type) (void);
  69   GType          ( *get_file_database_type)     (void);
  70   GTlsDatabase * ( *get_default_database)       (GTlsBackend *backend);
  71 };
  72
  73 GLIB_AVAILABLE_IN_ALL
  74 GType          g_tls_backend_get_type                   (void) G_GNUC_CONST;
  75
  76 GLIB_AVAILABLE_IN_ALL
  77 GTlsBackend *  g_tls_backend_get_default                (void);
  78
  79 GLIB_AVAILABLE_IN_ALL
  80 GTlsDatabase * g_tls_backend_get_default_database       (GTlsBackend *backend);
  81
  82 GLIB_AVAILABLE_IN_ALL
  83 gboolean       g_tls_backend_supports_tls               (GTlsBackend *backend);
  84
  85 GLIB_AVAILABLE_IN_ALL
  86 GType          g_tls_backend_get_certificate_type       (GTlsBackend *backend);
  87 GLIB_AVAILABLE_IN_ALL
  88 GType          g_tls_backend_get_client_connection_type (GTlsBackend *backend);
  89 GLIB_AVAILABLE_IN_ALL
  90 GType          g_tls_backend_get_server_connection_type (GTlsBackend *backend);
  91 GLIB_AVAILABLE_IN_ALL
  92 GType          g_tls_backend_get_file_database_type     (GTlsBackend *backend);
  93
  94 G_END_DECLS
  95
  96 #endif /* __G_TLS_BACKEND_H__ */