modules/core/include/dpl/waitable_handle.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *    Licensed under the Apache License, Version 2.0 (the "License");
   5  *    you may not use this file except in compliance with the License.
   6  *    You may obtain a copy of the License at
   7  *
   8  *        http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *    Unless required by applicable law or agreed to in writing, software
  11  *    distributed under the License is distributed on an "AS IS" BASIS,
  12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *    See the License for the specific language governing permissions and
  14  *    limitations under the License.
  15  */
  16 /*
  17  * @file        waitable_handle.h
  18  * @author      Przemyslaw Dobrowolski (p.dobrowolsk@samsung.com)
  19  * @version     1.0
  20  * @brief       This file is the header file of waitable handle
  21  */
  22 #ifndef DPL_WAITABLE_HANDLE_H
  23 #define DPL_WAITABLE_HANDLE_H
  24
  25 #include <dpl/noncopyable.h>
  26 #include <dpl/exception.h>
  27 #include <vector>
  28
  29 namespace DPL
  30 {
  31
  32 /**
  33  * Waitable unix wait handle definition
  34  */
  35 typedef int WaitableHandle;
  36
  37 /**
  38  * Waitable handle list
  39  */
  40 typedef std::vector<WaitableHandle> WaitableHandleList;
  41
  42 /**
  43  * Wait mode
  44  */
  45 class WaitMode
  46 {
  47 public:
  48     enum Type
  49     {
  50         Read,  ///< Wait for readability state changes
  51         Write  ///< Wait for writability state changes
  52     };
  53 };
  54
  55 /**
  56  * Waitable handle list ex
  57  */
  58 typedef std::vector<std::pair<WaitableHandle, WaitMode::Type> > WaitableHandleListEx;
  59
  60 /**
  61  * Waitable handle index list
  62  */
  63 typedef std::vector<size_t> WaitableHandleIndexList;
  64
  65 /**
  66  * Wait exceptions
  67  */
  68 DECLARE_EXCEPTION_TYPE(DPL::Exception, WaitFailed)
  69
  70 /**
  71  * Wait for single handle readability
  72  * Convience function.
  73  *
  74  * @return Signaled waitable handle index list
  75  * @throw WaitFailed Fatal error occurred while waiting for signal
  76  */
  77 WaitableHandleIndexList WaitForSingleHandle(WaitableHandle handle, unsigned long miliseconds = 0xFFFFFFFF);
  78
  79 /**
  80  * Wait for single handle
  81  * Convience function.
  82  *
  83  * @return Signaled waitable handle index list
  84  * @throw WaitFailed Fatal error occurred while waiting for signal
  85  */
  86 WaitableHandleIndexList WaitForSingleHandle(WaitableHandle handle, WaitMode::Type mode, unsigned long miliseconds = 0xFFFFFFFF);
  87
  88 /**
  89  * Wait for multiple handles readability
  90  *
  91  * @return Signaled waitable handle index list
  92  * @throw WaitFailed Fatal error occurred while waiting for signal
  93  */
  94 WaitableHandleIndexList WaitForMultipleHandles(const WaitableHandleList &handleList, unsigned long miliseconds = 0xFFFFFFFF);
  95
  96 /**
  97  * Wait for multiple handles readability
  98  *
  99  * @return Signaled waitable handle index list
 100  * @throw WaitFailed Fatal error occurred while waiting for signal
 101  */
 102 WaitableHandleIndexList WaitForMultipleHandles(const WaitableHandleListEx &handleListEx, unsigned long miliseconds = 0xFFFFFFFF);
 103
 104 } // namespace DPL
 105
 106 #endif // DPL_WAITABLE_HANDLE_H