blocxx
Select.hpp
Go to the documentation of this file.
1/*******************************************************************************
2* Copyright (C) 2005, Vintela, Inc. All rights reserved.
3* Copyright (C) 2006, Novell, Inc. All rights reserved.
4*
5* Redistribution and use in source and binary forms, with or without
6* modification, are permitted provided that the following conditions are met:
7*
8* * Redistributions of source code must retain the above copyright notice,
9* this list of conditions and the following disclaimer.
10* * Redistributions in binary form must reproduce the above copyright
11* notice, this list of conditions and the following disclaimer in the
12* documentation and/or other materials provided with the distribution.
13* * Neither the name of
14* Vintela, Inc.,
15* nor Novell, Inc.,
16* nor the names of its contributors or employees may be used to
17* endorse or promote products derived from this software without
18* specific prior written permission.
19*
20* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30* POSSIBILITY OF SUCH DAMAGE.
31*******************************************************************************/
32
33
38
39#ifndef BLOCXX_SELECT_HPP_
40#define BLOCXX_SELECT_HPP_
41#include "blocxx/BLOCXX_config.h"
42#include "blocxx/Types.hpp"
43#include "blocxx/Array.hpp"
45#include "blocxx/Timeout.hpp"
46
47// The classes and functions defined in this file are not meant for general
48// use, they are internal implementation details. They may change at any time.
49
50namespace BLOCXX_NAMESPACE
51{
52
54namespace Select
55{
59 const int SELECT_TIMEOUT = -2;
63 const int SELECT_ERROR = -1;
67 const int SELECT_NOT_IMPLEMENTED = -4;
71 const UInt32 INFINITE_TIMEOUT BLOCXX_DEPRECATED = ~0U;
72
86 BLOCXX_COMMON_API int select(const SelectTypeArray& selarray, UInt32 ms) BLOCXX_DEPRECATED;
87 BLOCXX_COMMON_API int select(const SelectTypeArray& selarray, const Timeout& timeout = Timeout::infinite);
88
90 {
92 : s(s_)
93 , waitForRead(false)
94 , waitForWrite(false)
95 , readAvailable(false)
96 , writeAvailable(false)
97 , wasError(false)
98 {
99 }
100
112 };
114
129 BLOCXX_COMMON_API int selectRW(SelectObjectArray& selarray, const Timeout& timeout = Timeout::infinite);
130
131 BLOCXX_COMMON_API int selectRW(SelectObjectArray& selarray, UInt32 ms) BLOCXX_DEPRECATED;
132
133} // end namespace Select
134
135} // end namespace BLOCXX_NAMESPACE
136
137#endif // BLOCXX_SELECT_HPP_
Array<> wraps std::vector<> in COWReference<> adding ref counting and copy on write capability.
Definition ArrayFwd.hpp:46
A timeout can be absolute, which means that it will happen at the specified DateTime.
Definition Timeout.hpp:56
static Timeout infinite
Definition Timeout.hpp:62
const UInt32 INFINITE_TIMEOUT BLOCXX_DEPRECATED
Value that means infinite timeout.
Definition Select.hpp:71
Array< SelectObject > SelectObjectArray
Definition Select.hpp:113
int select(const SelectTypeArray &selarray, UInt32 ms)
Select returns as soon as input is available on any of Select_t objects that are in given array.
Definition Select.cpp:490
const int SELECT_TIMEOUT
The value returned from select when the timeout value has expired.
Definition Select.hpp:59
const int SELECT_NOT_IMPLEMENTED
Used internally, but listed here to prevent conflicts.
Definition Select.hpp:67
int selectRW(SelectObjectArray &selarray, UInt32 ms)
Definition Select.cpp:92
const int SELECT_ERROR
The value returned from select when any error occurs other than timeout.
Definition Select.hpp:63
Taken from RFC 1321.
Array< Select_t > SelectTypeArray
Definition Select.hpp:53
bool wasError
Ouput parameter. Will be set to true to indicate that s has an error.
Definition Select.hpp:111
bool waitForRead
Input parameter. Set it to true to indicate that waiting for read availability on s is desired.
Definition Select.hpp:103
bool writeAvailable
Ouput parameter. Will be set to true to indicate that s has become available for writing.
Definition Select.hpp:109
bool waitForWrite
Input parameter. Set it to true to indicate that waiting for write availability on s is desired.
Definition Select.hpp:105
bool readAvailable
Ouput parameter. Will be set to true to indicate that s has become available for reading.
Definition Select.hpp:107