blocxx

SelectEngine.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_ENGINE_HPP_
00040 #define BLOCXX_SELECT_ENGINE_HPP_
00041 #include "blocxx/BLOCXX_config.h"
00042 #include "blocxx/SelectableIFC.hpp"
00043 #include "blocxx/SelectableCallbackIFC.hpp"
00044 #include "blocxx/SortedVectorMap.hpp"
00045 #include "blocxx/Exception.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 BLOCXX_DECLARE_APIEXCEPTION(Select, BLOCXX_COMMON_API)
00054 class BLOCXX_COMMON_API SelectEngine
00055 {
00056 public:
00061    void addSelectableObject(const Select_t& obj,
00062       const SelectableCallbackIFCRef& cb, SelectableCallbackIFC::EEventType eventType);
00064    bool removeSelectableObject(const Select_t& obj, SelectableCallbackIFC::EEventType eventType);
00065    void go(const Timeout& timeout); // Throws SelectException on error
00066    void stop();
00067 private:
00068 
00069    struct Data
00070    {
00071       Data(const SelectableCallbackIFCRef& callback_,
00072          SelectableCallbackIFC::EEventType eventType_)
00073          : callback(callback_)
00074          , eventType(eventType_)
00075       {
00076       }
00077 
00078       SelectableCallbackIFCRef callback;
00079       SelectableCallbackIFC::EEventType eventType;
00080 
00081    };
00082 
00083    SortedVectorMap<Select_t, Data> m_table; // the key is Data::selectObj->getSelectObj()
00084 
00085    bool m_stopFlag;
00086 };
00087 
00088 class BLOCXX_COMMON_API SelectEngineStopper : public SelectableCallbackIFC
00089 {
00090 public:
00091    SelectEngineStopper(SelectEngine& engine);
00092 protected:
00093    virtual void doSelected(Select_t& selectedObject, EEventType eventType);
00094 private:
00095    SelectEngine& m_engine;
00096 };
00097 
00098 } // end namespace BLOCXX_NAMESPACE
00099 
00100 #endif