observer.h 3.09 KB
/* GNU Mailutils -- a suite of utilities for electronic mail
   Copyright (C) 1999-2000, 2005, 2007, 2010-2012 Free Software
   Foundation, Inc.

   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; either
   version 3 of the License, or (at your option) any later version.

   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/>. */

#ifndef _MAILUTILS_OBSERVER_H
#define _MAILUTILS_OBSERVER_H

#include <mailutils/types.h>

#ifdef __cplusplus
extern "C" {
#endif
  /* Mailbox events */
                                               /* Call data type: */
#define MU_EVT_MAILBOX_DESTROY          0x001  /*  mu_mailbox_t */
#define MU_EVT_MAILBOX_PROGRESS         0x002  /*  NULL: FIXME? */
#define MU_EVT_MAILBOX_CORRUPT          0x004  /*  mu_mailbox_t */
#define MU_EVT_MAILBOX_MESSAGE_APPEND   0x008  /*  mu_message_qid_t: FIXME */ 
#define MU_EVT_MAILBOX_MESSAGE_EXPUNGE  0x010  /*  size_t [2]
					           (message number/number of 
					            messages removed so far) */
  /* Folder events */
#define MU_EVT_FOLDER_DESTROY           0x020  /*  mu_folder_t */
#define MU_EVT_FOLDER_AUTHORITY_FAILED  0x040  /*  NULL */

  /* Message events */
#define MU_EVT_MESSAGE_DESTROY          0x080  /*  mu_message_t */
#define MU_EVT_MESSAGE_ADD              0x100  /*  size_t *: FIXME */

  /* Mailer events */
#define MU_EVT_MAILER_DESTROY           0x200  /*  mu_mailer_t */
#define MU_EVT_MAILER_MESSAGE_SENT      0x400  /*  mu_message_t */
  
#define MU_OBSERVER_NO_CHECK 1

extern int mu_observer_create      (mu_observer_t *, void *owner);
extern void mu_observer_destroy    (mu_observer_t *, void *owner);
extern void * mu_observer_get_owner(mu_observer_t);
extern int mu_observer_action      (mu_observer_t, size_t type, void *data);
extern int mu_observer_set_action  (mu_observer_t, 
				    int (*_action) (mu_observer_t,
						    size_t, void *, void *),
				    void *owner);
extern int mu_observer_set_action_data  (mu_observer_t, void *data,
					 void *owner);
extern int mu_observer_set_destroy (mu_observer_t, 
				    int (*_destroy) (mu_observer_t, void *),
				    void *owner);
extern int mu_observer_set_flags   (mu_observer_t, int flags);

extern int mu_observable_create    (mu_observable_t *, void *owner);
extern void mu_observable_destroy  (mu_observable_t *, void *owner);
extern void * mu_observable_get_owner (mu_observable_t);
extern int mu_observable_attach    (mu_observable_t, size_t type,
				    mu_observer_t observer);
extern int mu_observable_detach    (mu_observable_t, mu_observer_t observer);
extern int mu_observable_notify    (mu_observable_t, int type, void *data);

#ifdef __cplusplus
}
#endif

#endif /* _MAILUTILS_OBSERVER_H */