2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * @file waitable_handle.h
18 * @author Przemyslaw Dobrowolski (p.dobrowolsk@samsung.com)
20 * @brief This file is the header file of waitable handle
22 #ifndef DPL_WAITABLE_HANDLE_H
23 #define DPL_WAITABLE_HANDLE_H
25 #include <dpl/noncopyable.h>
26 #include <dpl/exception.h>
31 * Waitable unix wait handle definition
33 typedef int WaitableHandle;
36 * Waitable handle list
38 typedef std::vector<WaitableHandle> WaitableHandleList;
48 Read, ///< Wait for readability state changes
49 Write ///< Wait for writability state changes
54 * Waitable handle list ex
56 typedef std::vector<std::pair<WaitableHandle,
57 WaitMode::Type> > WaitableHandleListEx;
60 * Waitable handle index list
62 typedef std::vector<size_t> WaitableHandleIndexList;
67 DECLARE_EXCEPTION_TYPE(DPL::Exception, WaitFailed)
70 * Wait for single handle readability
73 * @return Signaled waitable handle index list
74 * @throw WaitFailed Fatal error occurred while waiting for signal
76 WaitableHandleIndexList WaitForSingleHandle(
77 WaitableHandle handle,
78 unsigned long miliseconds =
82 * Wait for single handle
85 * @return Signaled waitable handle index list
86 * @throw WaitFailed Fatal error occurred while waiting for signal
88 WaitableHandleIndexList WaitForSingleHandle(
89 WaitableHandle handle,
91 unsigned long miliseconds =
95 * Wait for multiple handles readability
97 * @return Signaled waitable handle index list
98 * @throw WaitFailed Fatal error occurred while waiting for signal
100 WaitableHandleIndexList WaitForMultipleHandles(
101 const WaitableHandleList &handleList,
102 unsigned long miliseconds = 0xFFFFFFFF);
105 * Wait for multiple handles readability
107 * @return Signaled waitable handle index list
108 * @throw WaitFailed Fatal error occurred while waiting for signal
110 WaitableHandleIndexList WaitForMultipleHandles(
111 const WaitableHandleListEx &handleListEx,
112 unsigned long miliseconds = 0xFFFFFFFF);
115 #endif // DPL_WAITABLE_HANDLE_H