Annotation of libaitsched/inc/hooks.h, revision 1.1

1.1     ! misho       1: /*************************************************************************
        !             2: * (C) 2011 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
        !             3: *  by Michael Pounov <misho@openbsd-bg.org>
        !             4: *
        !             5: * $Author: misho $
        !             6: * $Id: aitcrc.c,v 1.4.2.1 2011/05/10 20:48:49 misho Exp $
        !             7: *
        !             8: **************************************************************************
        !             9: The ELWIX and AITNET software is distributed under the following
        !            10: terms:
        !            11: 
        !            12: All of the documentation and software included in the ELWIX and AITNET
        !            13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
        !            14: 
        !            15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
        !            16:        by Michael Pounov <misho@elwix.org>.  All rights reserved.
        !            17: 
        !            18: Redistribution and use in source and binary forms, with or without
        !            19: modification, are permitted provided that the following conditions
        !            20: are met:
        !            21: 1. Redistributions of source code must retain the above copyright
        !            22:    notice, this list of conditions and the following disclaimer.
        !            23: 2. Redistributions in binary form must reproduce the above copyright
        !            24:    notice, this list of conditions and the following disclaimer in the
        !            25:    documentation and/or other materials provided with the distribution.
        !            26: 3. All advertising materials mentioning features or use of this software
        !            27:    must display the following acknowledgement:
        !            28: This product includes software developed by Michael Pounov <misho@elwix.org>
        !            29: ELWIX - Embedded LightWeight unIX and its contributors.
        !            30: 4. Neither the name of AITNET nor the names of its contributors
        !            31:    may be used to endorse or promote products derived from this software
        !            32:    without specific prior written permission.
        !            33: 
        !            34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
        !            35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        !            36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
        !            37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
        !            38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        !            39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
        !            40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
        !            41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
        !            42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
        !            43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
        !            44: SUCH DAMAGE.
        !            45: */
        !            46: #ifndef __HOOKS_H
        !            47: #define __HOOKS_H
        !            48: 
        !            49: 
        !            50: struct sched_IO {
        !            51:        fd_set          rfd;
        !            52:        fd_set          wfd;
        !            53:        fd_set          xfd;
        !            54:        struct timeval  timeout;
        !            55: };
        !            56: 
        !            57: 
        !            58: /*
        !            59:  * sched_hook_init() - Default INIT hook
        !            60:  * @root = root task
        !            61:  * @data = optional data if !=NULL
        !            62:  * return: <0 errors and 0 ok
        !            63:  */
        !            64: void *sched_hook_init(void *root, void *data);
        !            65: 
        !            66: /*
        !            67:  * sched_hook_fini() - Default FINI hook
        !            68:  * @root = root task
        !            69:  * @arg = unused
        !            70:  * return: <0 errors and 0 ok
        !            71:  */
        !            72: void *sched_hook_fini(void *root, void *arg __unused);
        !            73: 
        !            74: /*
        !            75:  * sched_hook_fetch() - Default FETCH hook
        !            76:  * @root = root task
        !            77:  * @arg = unused
        !            78:  * return: NULL error or !=NULL fetched task
        !            79:  */
        !            80: void *sched_hook_fetch(void *root, void *arg __unused);
        !            81: 
        !            82: /*
        !            83:  * sched_hook_cancel() - Default CANCEL hook
        !            84:  * @task = current task
        !            85:  * @arg = unused
        !            86:  * return: <0 errors and 0 ok
        !            87:  */
        !            88: void *sched_hook_cancel(void *task, void *arg __unused);
        !            89: 
        !            90: /*
        !            91:  * sched_hook_read() - Default READ hook
        !            92:  * @task = current task
        !            93:  * @arg = unused
        !            94:  * return: <0 errors and 0 ok
        !            95:  */
        !            96: void *sched_hook_read(void *task, void *arg __unused);
        !            97: 
        !            98: /*
        !            99:  * sched_hook_write() - Default WRITE hook
        !           100:  * @task = current task
        !           101:  * @arg = unused
        !           102:  * return: <0 errors and 0 ok
        !           103:  */
        !           104: void *sched_hook_write(void *task, void *arg __unused);
        !           105: 
        !           106: 
        !           107: #endif

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>