examples/vm_power_manager/channel_monitor.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef CHANNEL_MONITOR_H_
  35 #define CHANNEL_MONITOR_H_
  36
  37 #include "channel_manager.h"
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 /**
  44  * Setup the Channel Monitor resources required to initialize epoll.
  45  * Must be called first before calling other functions.
  46  *
  47  * @return
  48  *  - 0 on success.
  49  *  - Negative on error.
  50  */
  51 int channel_monitor_init(void);
  52
  53 /**
  54  * Run the channel monitor, loops forever on on epoll_wait.
  55  *
  56  *
  57  * @return
  58  *  None
  59  */
  60 void run_channel_monitor(void);
  61
  62 /**
  63  * Exit the Channel Monitor, exiting the epoll_wait loop and events processing.
  64  *
  65  * @return
  66  *  - 0 on success.
  67  *  - Negative on error.
  68  */
  69 void channel_monitor_exit(void);
  70
  71 /**
  72  * Add an open channel to monitor via epoll. A pointer to struct channel_info
  73  * will be registered with epoll for event processing.
  74  * It is thread-safe.
  75  *
  76  * @param chan_info
  77  *  Pointer to struct channel_info pointer.
  78  *
  79  * @return
  80  *  - 0 on success.
  81  *  - Negative on error.
  82  */
  83 int add_channel_to_monitor(struct channel_info **chan_info);
  84
  85 /**
  86  * Remove a previously added channel from epoll control.
  87  *
  88  * @param chan_info
  89  *  Pointer to struct channel_info.
  90  *
  91  * @return
  92  *  - 0 on success.
  93  *  - Negative on error.
  94  */
  95 int remove_channel_from_monitor(struct channel_info *chan_info);
  96
  97 #ifdef __cplusplus
  98 }
  99 #endif
 100
 101
 102 #endif /* CHANNEL_MONITOR_H_ */