SelectEngine.hpp

Go to the documentation of this file.
00001 /*******************************************************************************
00002 * Copyright (C) 2004 Vintela, Inc. All rights reserved.
00003 * Copyright (C) 2005 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 *
00011 *  - Redistributions in binary form must reproduce the above copyright notice,
00012 *    this list of conditions and the following disclaimer in the documentation
00013 *    and/or other materials provided with the distribution.
00014 *
00015 *  - Neither the name of Vintela, Inc., Novell, Inc., nor the names of its
00016 *    contributors may be used to endorse or promote products derived from this
00017 *    software without specific prior written permission.
00018 *
00019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00020 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00021 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00022 * ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc., Novell, Inc., OR THE 
00023 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
00024 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
00025 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
00026 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
00027 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
00028 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
00029 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00030 *******************************************************************************/
00031 
00032 
00038 #ifndef BLOCXX_SELECT_ENGINE_HPP_
00039 #define BLOCXX_SELECT_ENGINE_HPP_
00040 #include "blocxx/BLOCXX_config.h"
00041 #include "blocxx/SelectableIFC.hpp"
00042 #include "blocxx/SelectableCallbackIFC.hpp"
00043 #include "blocxx/Array.hpp"
00044 #include "blocxx/Exception.hpp"
00045 
00046 // The classes and functions defined in this file are not meant for general
00047 // use, they are internal implementation details.  They may change at any time.
00048 
00049 namespace BLOCXX_NAMESPACE
00050 {
00051 
00052 BLOCXX_DECLARE_APIEXCEPTION(Select, BLOCXX_COMMON_API)
00053 class BLOCXX_COMMON_API SelectEngine
00054 {
00055 public:
00056    void addSelectableObject(const SelectableIFCRef& obj,
00057       const SelectableCallbackIFCRef& cb);
00058    void go(); // Throws SelectException on error
00059    void stop();
00060 private:
00061 
00062 #ifdef BLOCXX_WIN32
00063 #pragma warning (push)
00064 #pragma warning (disable: 4251)
00065 #endif
00066 
00067    Array<SelectableIFCRef> m_selectableObjs;
00068    Array<SelectableCallbackIFCRef> m_callbacks;
00069 
00070 #ifdef BLOCXX_WIN32
00071 #pragma warning (pop)
00072 #endif
00073 
00074    bool m_stopFlag;
00075 };
00076 
00077 class BLOCXX_COMMON_API SelectEngineStopper : public SelectableCallbackIFC
00078 {
00079 public:
00080    SelectEngineStopper(SelectEngine& engine);
00081 protected:
00082    virtual void doSelected(SelectableIFCRef& selectedObject);
00083 private:
00084    SelectEngine& m_engine;
00085 };
00086 
00087 } // end namespace BLOCXX_NAMESPACE
00088 
00089 #endif

Generated on Fri Jun 16 15:39:09 2006 for blocxx by  doxygen 1.4.6