blocxx

Timeout.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 
00038 #ifndef BLOCXX_TIMEOUT_HPP_INCLUDE_GUARD_
00039 #define BLOCXX_TIMEOUT_HPP_INCLUDE_GUARD_
00040 
00041 #include "blocxx/BLOCXX_config.h"
00042 #include "blocxx/CommonFwd.hpp"
00043 #include "blocxx/DateTime.hpp"
00044 
00045 namespace BLOCXX_NAMESPACE
00046 {
00047 
00055 class BLOCXX_COMMON_API Timeout
00056 {
00057 public:
00058    static Timeout absolute(const DateTime& dt);
00059    static Timeout relative(float seconds);
00060    static Timeout relativeWithReset(float seconds);
00061 
00062    static Timeout infinite;
00063 
00064    enum ETimeoutType
00065    {
00066       E_ABSOLUTE,
00067       E_RELATIVE,
00068       E_RELATIVE_WITH_RESET
00069    };
00070 
00071    ETimeoutType getType() const;
00072    DateTime getAbsolute() const;
00073    float getRelative() const;
00074 
00075 private:
00076    // have to use static factory functions to create a Timeout instance
00077    Timeout();
00078    Timeout(ETimeoutType type, const DateTime& dt);
00079    Timeout(ETimeoutType type, float seconds);
00080 
00081    ETimeoutType m_type;
00082    DateTime m_absolute;
00083    float m_seconds;
00084 };
00085 
00086 BLOCXX_COMMON_API bool operator==(const Timeout& x, const Timeout& y);
00087 BLOCXX_COMMON_API bool operator!=(const Timeout& x, const Timeout& y);
00088 
00089 } // end namespace BLOCXX_NAMESPACE
00090 
00091 #endif
00092 
00093