5120d7098b
* camel-service.c: Change "gboolean connected" to "CamelServiceConnectionStatus status", which can be disconnected, connecting, connected, or disconnecting. (camel_service_init, camel_service_finalize): create/destroy the connect_op_lock. Refer to service->status rather than service->connected. (camel_service_connect): When connecting, note the current operation (and create a new one if there's none registered) and mark the connection "connecting" until we succeed or fail. (camel_service_disconnect): Likewise in reverse. (camel_service_cancel_connect): New function to cancel a connection attempt. (cancel_connect): Default implementation: Call camel_operation_cancel on the connect_op. * camel-disco-store.c (disco_connect): Only call CamelRemoteStore's connect func if we're online. (disco_cancel_connect): Fall back to offline if a connection gets cancelled. (disco_get_folder_info): Kludge: call connect explicitly before deciding whether to do the online or offline version, so if the connect fails, we fall back correctly. * camel-session.c (camel_session_get_service_connected): s/svc->connected/svc->status/ * camel-remote-store.c (camel_remote_store_finalise): Change service->connected check to service->status check. (remote_connect): Don't set service->connected here: camel_service_connect() itself does that. * camel-operation.c (camel_operation_registered): Deal with the possibility that there's no registered op. svn path=/trunk/; revision=13191
142 lines
4.4 KiB
C
142 lines
4.4 KiB
C
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
|
|
/* camel-service.h : Abstract class for an email service */
|
|
|
|
/*
|
|
*
|
|
* Author :
|
|
* Bertrand Guiheneuf <bertrand@helixcode.com>
|
|
*
|
|
* Copyright 1999, 2000 Ximian, Inc. (www.ximian.com)
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License as
|
|
* published by the Free Software Foundation; either version 2 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
* USA
|
|
*/
|
|
|
|
|
|
#ifndef CAMEL_SERVICE_H
|
|
#define CAMEL_SERVICE_H 1
|
|
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#pragma }
|
|
#endif /* __cplusplus }*/
|
|
|
|
#include <netdb.h>
|
|
#include <camel/camel-object.h>
|
|
#include <camel/camel-url.h>
|
|
#include <camel/camel-provider.h>
|
|
#include <camel/camel-operation.h>
|
|
|
|
#define CAMEL_SERVICE_TYPE (camel_service_get_type ())
|
|
#define CAMEL_SERVICE(obj) (CAMEL_CHECK_CAST((obj), CAMEL_SERVICE_TYPE, CamelService))
|
|
#define CAMEL_SERVICE_CLASS(k) (CAMEL_CHECK_CLASS_CAST ((k), CAMEL_SERVICE_TYPE, CamelServiceClass))
|
|
#define CAMEL_IS_SERVICE(o) (CAMEL_CHECK_TYPE((o), CAMEL_SERVICE_TYPE))
|
|
|
|
|
|
typedef enum {
|
|
CAMEL_SERVICE_DISCONNECTED,
|
|
CAMEL_SERVICE_CONNECTING,
|
|
CAMEL_SERVICE_CONNECTED,
|
|
CAMEL_SERVICE_DISCONNECTING
|
|
} CamelServiceConnectionStatus;
|
|
|
|
struct _CamelService {
|
|
CamelObject parent_object;
|
|
struct _CamelServicePrivate *priv;
|
|
|
|
CamelSession *session;
|
|
CamelProvider *provider;
|
|
CamelServiceConnectionStatus status;
|
|
CamelOperation *connect_op;
|
|
CamelURL *url;
|
|
};
|
|
|
|
|
|
typedef struct {
|
|
CamelObjectClass parent_class;
|
|
|
|
void (*construct) (CamelService *service,
|
|
CamelSession *session,
|
|
CamelProvider *provider,
|
|
CamelURL *url,
|
|
CamelException *ex);
|
|
|
|
gboolean (*connect) (CamelService *service,
|
|
CamelException *ex);
|
|
gboolean (*disconnect) (CamelService *service,
|
|
gboolean clean,
|
|
CamelException *ex);
|
|
void (*cancel_connect) (CamelService *service);
|
|
|
|
GList * (*query_auth_types) (CamelService *service,
|
|
CamelException *ex);
|
|
|
|
char * (*get_name) (CamelService *service,
|
|
gboolean brief);
|
|
char * (*get_path) (CamelService *service);
|
|
|
|
} CamelServiceClass;
|
|
|
|
|
|
/* query_auth_types returns a GList of these */
|
|
typedef struct {
|
|
char *name; /* user-friendly name */
|
|
char *description;
|
|
char *authproto;
|
|
|
|
gboolean need_password; /* needs a password to authenticate */
|
|
} CamelServiceAuthType;
|
|
|
|
|
|
/* public methods */
|
|
void camel_service_construct (CamelService *service,
|
|
CamelSession *session,
|
|
CamelProvider *provider,
|
|
CamelURL *url,
|
|
CamelException *ex);
|
|
gboolean camel_service_connect (CamelService *service,
|
|
CamelException *ex);
|
|
gboolean camel_service_disconnect (CamelService *service,
|
|
gboolean clean,
|
|
CamelException *ex);
|
|
void camel_service_cancel_connect (CamelService *service);
|
|
char * camel_service_get_url (CamelService *service);
|
|
char * camel_service_get_name (CamelService *service,
|
|
gboolean brief);
|
|
char * camel_service_get_path (CamelService *service);
|
|
CamelSession * camel_service_get_session (CamelService *service);
|
|
CamelProvider * camel_service_get_provider (CamelService *service);
|
|
GList * camel_service_query_auth_types (CamelService *service,
|
|
CamelException *ex);
|
|
|
|
/* convenience functions */
|
|
struct hostent * camel_service_gethost (CamelService *service,
|
|
CamelException *ex);
|
|
|
|
/* cancellable dns lookup */
|
|
struct hostent * camel_get_host_byname (const char *name, CamelException *ex);
|
|
void camel_free_host (struct hostent *h);
|
|
|
|
/* Standard Camel function */
|
|
CamelType camel_service_get_type (void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* CAMEL_SERVICE_H */
|
|
|