1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/*
* e-backend.h
*
* 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.
*
* 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/>.
*
*/
#if !defined (__LIBEBACKEND_H_INSIDE__) && !defined (LIBEBACKEND_COMPILATION)
#error "Only <libebackend/libebackend.h> should be included directly."
#endif
#ifndef E_BACKEND_H
#define E_BACKEND_H
#include <libedataserver/libedataserver.h>
/* Standard GObject macros */
#define E_TYPE_BACKEND \
(e_backend_get_type ())
#define E_BACKEND(obj) \
(G_TYPE_CHECK_INSTANCE_CAST \
((obj), E_TYPE_BACKEND, EBackend))
#define E_BACKEND_CLASS(cls) \
(G_TYPE_CHECK_CLASS_CAST \
((cls), E_TYPE_BACKEND, EBackendClass))
#define E_IS_BACKEND(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE \
((obj), E_TYPE_BACKEND))
#define E_IS_BACKEND_CLASS(cls) \
(G_TYPE_CHECK_CLASS_TYPE \
((cls), E_TYPE_BACKEND))
#define E_BACKEND_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS \
((obj), E_TYPE_BACKEND, EBackendClass))
G_BEGIN_DECLS
/* forward declaration */
struct _EUserPrompter;
typedef struct _EBackend EBackend;
typedef struct _EBackendClass EBackendClass;
typedef struct _EBackendPrivate EBackendPrivate;
/**
* EBackend:
*
* Contains only private data that should be read and manipulated using the
* functions below.
*
* Since: 3.4
**/
struct _EBackend {
/*< private >*/
GObject parent;
EBackendPrivate *priv;
};
/**
* EBackendClass:
* @authenticate_sync: Authenticate synchronously
* @authenticate: Initiate authentication
* @authenticate_finish: Complete authentication
* @get_destination_address: Fetch the destination address
*
* Base class structure for the #EBackend class
*
* Since: 3.4
**/
struct _EBackendClass {
/*< private >*/
GObjectClass parent_class;
/*< public >*/
/* Methods */
gboolean (*get_destination_address)
(EBackend *backend,
gchar **host,
guint16 *port);
void (*prepare_shutdown) (EBackend *backend);
ESourceAuthenticationResult
(*authenticate_sync) (EBackend *backend,
const ENamedParameters *credentials,
gchar **out_certificate_pem,
GTlsCertificateFlags *out_certificate_errors,
GCancellable *cancellable,
GError **error);
/*< private >*/
gpointer reserved[11];
};
GType e_backend_get_type (void) G_GNUC_CONST;
gboolean e_backend_get_online (EBackend *backend);
void e_backend_set_online (EBackend *backend,
gboolean online);
ESource * e_backend_get_source (EBackend *backend);
GSocketConnectable *
e_backend_ref_connectable (EBackend *backend);
void e_backend_set_connectable (EBackend *backend,
GSocketConnectable *connectable);
GMainContext * e_backend_ref_main_context (EBackend *backend);
gboolean e_backend_credentials_required_sync
(EBackend *backend,
ESourceCredentialsReason reason,
const gchar *certificate_pem,
GTlsCertificateFlags certificate_errors,
const GError *op_error,
GCancellable *cancellable,
GError **error);
void e_backend_credentials_required (EBackend *backend,
ESourceCredentialsReason reason,
const gchar *certificate_pem,
GTlsCertificateFlags certificate_errors,
const GError *op_error,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean e_backend_credentials_required_finish
(EBackend *backend,
GAsyncResult *result,
GError **error);
void e_backend_schedule_credentials_required
(EBackend *backend,
ESourceCredentialsReason reason,
const gchar *certificate_pem,
GTlsCertificateFlags certificate_errors,
const GError *op_error,
GCancellable *cancellable,
const gchar *who_calls);
void e_backend_schedule_authenticate (EBackend *backend,
const ENamedParameters *credentials);
void e_backend_ensure_source_status_connected
(EBackend *backend);
struct _EUserPrompter *
e_backend_get_user_prompter (EBackend *backend);
ETrustPromptResponse
e_backend_trust_prompt_sync (EBackend *backend,
const ENamedParameters *parameters,
GCancellable *cancellable,
GError **error);
void e_backend_trust_prompt (EBackend *backend,
const ENamedParameters *parameters,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
ETrustPromptResponse
e_backend_trust_prompt_finish (EBackend *backend,
GAsyncResult *result,
GError **error);
gboolean e_backend_get_destination_address
(EBackend *backend,
gchar **host,
guint16 *port);
gboolean e_backend_is_destination_reachable
(EBackend *backend,
GCancellable *cancellable,
GError **error);
void e_backend_prepare_shutdown (EBackend *backend);
G_END_DECLS
#endif /* E_BACKEND_H */
|
