blocxx

Select.hpp

Go to the documentation of this file.
00001 /*******************************************************************************
00002 * Copyright (C) 2005, Vintela, Inc. All rights reserved.
00003 * Copyright (C) 2006, Novell, Inc. All rights reserved.
00004 * 
00005 * Redistribution and use in source and binary forms, with or without
00006 * modification, are permitted provided that the following conditions are met:
00007 * 
00008 *     * Redistributions of source code must retain the above copyright notice,
00009 *       this list of conditions and the following disclaimer.
00010 *     * Redistributions in binary form must reproduce the above copyright
00011 *       notice, this list of conditions and the following disclaimer in the
00012 *       documentation and/or other materials provided with the distribution.
00013 *     * Neither the name of 
00014 *       Vintela, Inc., 
00015 *       nor Novell, Inc., 
00016 *       nor the names of its contributors or employees may be used to 
00017 *       endorse or promote products derived from this software without 
00018 *       specific prior written permission.
00019 * 
00020 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00021 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00022 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00023 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00024 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00025 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00026 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00027 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00028 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00029 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00030 * POSSIBILITY OF SUCH DAMAGE.
00031 *******************************************************************************/
00032 
00033 
00039 #ifndef BLOCXX_SELECT_HPP_
00040 #define BLOCXX_SELECT_HPP_
00041 #include "blocxx/BLOCXX_config.h"
00042 #include "blocxx/Types.hpp"
00043 #include "blocxx/Array.hpp"
00044 #include "blocxx/SelectableIFC.hpp"
00045 #include "blocxx/Timeout.hpp"
00046 
00047 // The classes and functions defined in this file are not meant for general
00048 // use, they are internal implementation details.  They may change at any time.
00049 
00050 namespace BLOCXX_NAMESPACE
00051 {
00052 
00053 typedef Array<Select_t> SelectTypeArray;
00054 namespace Select
00055 {
00059    const int SELECT_TIMEOUT = -2;
00063    const int SELECT_ERROR = -1;
00067    const int SELECT_NOT_IMPLEMENTED = -4;
00071    const UInt32 INFINITE_TIMEOUT BLOCXX_DEPRECATED = ~0U;
00072    
00086    BLOCXX_COMMON_API int select(const SelectTypeArray& selarray, UInt32 ms) BLOCXX_DEPRECATED;
00087    BLOCXX_COMMON_API int select(const SelectTypeArray& selarray, const Timeout& timeout = Timeout::infinite);
00088 
00089    struct SelectObject
00090    {
00091       SelectObject(Select_t s_)
00092       : s(s_)
00093       , waitForRead(false)
00094       , waitForWrite(false)
00095       , readAvailable(false)
00096       , writeAvailable(false)
00097       , wasError(false)
00098       {
00099       }
00100 
00101       Select_t s;
00103       bool waitForRead; 
00105       bool waitForWrite; 
00107       bool readAvailable;
00109       bool writeAvailable;
00111       bool wasError;
00112    };
00113    typedef Array<SelectObject> SelectObjectArray;
00114 
00129    BLOCXX_COMMON_API int selectRW(SelectObjectArray& selarray, const Timeout& timeout = Timeout::infinite);
00130 
00131    BLOCXX_COMMON_API int selectRW(SelectObjectArray& selarray, UInt32 ms) BLOCXX_DEPRECATED;
00132 
00133 } // end namespace Select
00134 
00135 } // end namespace BLOCXX_NAMESPACE
00136 
00137 #endif // BLOCXX_SELECT_HPP_