1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
2 /* camel-service.h : Abstract class for an email service */
7 * Bertrand Guiheneuf <bertrand@helixcode.com>
9 * Copyright 1999, 2000 Ximian, Inc. (www.ximian.com)
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License as
13 * published by the Free Software Foundation; either version 2 of the
14 * License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
28 #ifndef CAMEL_SERVICE_H
29 #define CAMEL_SERVICE_H 1
35 #endif /* __cplusplus }*/
38 #include <camel/camel-object.h>
39 #include <camel/camel-url.h>
40 #include <camel/camel-provider.h>
41 #include <camel/camel-operation.h>
43 #define CAMEL_SERVICE_TYPE (camel_service_get_type ())
44 #define CAMEL_SERVICE(obj) (CAMEL_CHECK_CAST((obj), CAMEL_SERVICE_TYPE, CamelService))
45 #define CAMEL_SERVICE_CLASS(k) (CAMEL_CHECK_CLASS_CAST ((k), CAMEL_SERVICE_TYPE, CamelServiceClass))
46 #define CAMEL_IS_SERVICE(o) (CAMEL_CHECK_TYPE((o), CAMEL_SERVICE_TYPE))
50 CAMEL_SERVICE_DISCONNECTED,
51 CAMEL_SERVICE_CONNECTING,
52 CAMEL_SERVICE_CONNECTED,
53 CAMEL_SERVICE_DISCONNECTING
54 } CamelServiceConnectionStatus;
56 struct _CamelService {
57 CamelObject parent_object;
58 struct _CamelServicePrivate *priv;
60 CamelSession *session;
61 CamelProvider *provider;
62 CamelServiceConnectionStatus status;
63 CamelOperation *connect_op;
69 CamelObjectClass parent_class;
71 void (*construct) (CamelService *service,
72 CamelSession *session,
73 CamelProvider *provider,
77 gboolean (*connect) (CamelService *service,
79 gboolean (*disconnect) (CamelService *service,
82 void (*cancel_connect) (CamelService *service);
84 GList * (*query_auth_types) (CamelService *service,
87 char * (*get_name) (CamelService *service,
89 char * (*get_path) (CamelService *service);
94 /* query_auth_types returns a GList of these */
96 char *name; /* user-friendly name */
100 gboolean need_password; /* needs a password to authenticate */
101 } CamelServiceAuthType;
105 void camel_service_construct (CamelService *service,
106 CamelSession *session,
107 CamelProvider *provider,
110 gboolean camel_service_connect (CamelService *service,
112 gboolean camel_service_disconnect (CamelService *service,
115 void camel_service_cancel_connect (CamelService *service);
116 char * camel_service_get_url (CamelService *service);
117 char * camel_service_get_name (CamelService *service,
119 char * camel_service_get_path (CamelService *service);
120 CamelSession * camel_service_get_session (CamelService *service);
121 CamelProvider * camel_service_get_provider (CamelService *service);
122 GList * camel_service_query_auth_types (CamelService *service,
125 /* convenience functions */
126 struct hostent * camel_service_gethost (CamelService *service,
129 /* cancellable dns lookup */
130 struct hostent * camel_get_host_byname (const char *name, CamelException *ex);
131 void camel_free_host (struct hostent *h);
133 /* Standard Camel function */
134 CamelType camel_service_get_type (void);
138 #endif /* __cplusplus */
140 #endif /* CAMEL_SERVICE_H */