/* * Copyright (c) 1998-2003 Carnegie Mellon University. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The name "Carnegie Mellon University" must not be used to * endorse or promote products derived from this software without * prior written permission. For permission or any other legal * details, please contact * Office of Technology Transfer * Carnegie Mellon University * 5000 Forbes Avenue * Pittsburgh, PA 15213-3890 * (412) 268-4387, fax: (412) 268-7395 * tech-transfer@andrew.cmu.edu * * 4. Redistributions of any form whatsoever must retain the following * acknowledgment: * "This product includes software developed by Computing Services * at Carnegie Mellon University (http://www.cmu.edu/computing/)." * * CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY * AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE * FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ /* $Id: idle.h,v 1.8 2006/11/30 17:11:17 murch Exp $ */ #ifndef IDLE_H #define IDLE_H #include "mailbox.h" extern const char *idle_method_desc; typedef enum { IDLE_MAILBOX = 0x1, IDLE_ALERT = 0x2 } idle_flags_t; typedef void idle_updateproc_t(idle_flags_t flags); /* Is IDLE enabled? Can also do initial setup, if necessary */ int idle_enabled(void); /* Setup for IDLE. * 'proc' is a pointer to a function which reports mailbox updates and/or * ALERTs to the client. */ int idle_init(idle_updateproc_t *proc); /* Start IDLEing on 'mailbox'. */ void idle_start(struct mailbox *mailbox); /* Cleanup when IDLE is completed. */ void idle_done(struct mailbox *mailbox); #endif