libcore/include/sirikata/core/network/IOTimer.hpp

Go to the documentation of this file.

/*  Sirikata Network Utilities
 *  IOTimer.hpp
 *
 *  Copyright (c) 2009, Daniel Reiter Horn
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are
 *  met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name of Sirikata nor the names of its contributors may
 *    be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef _SIRIKATA_IOTIMER_HPP_
#define _SIRIKATA_IOTIMER_HPP_

#include <sirikata/core/util/Platform.hpp>
#include <sirikata/core/network/IODefs.hpp>
#include <sirikata/core/util/AtomicTypes.hpp>
#include <sirikata/core/util/SerializationCheck.hpp>

namespace Sirikata {
namespace Network {

typedef std::tr1::shared_ptr<IOTimer> IOTimerPtr;
typedef std::tr1::weak_ptr<IOTimer> IOTimerWPtr;

class SIRIKATA_EXPORT IOTimer : public std::tr1::enable_shared_from_this<IOTimer> {
    DeadlineTimer *mTimer;
    IOStrand* mStrand;
    IOCallback mFunc;
    SerializationCheck chk;

    AtomicValue<uint32> mCanceled;

    class TimedOut;


    IOTimer(IOService &io);

    IOTimer(IOService &io, const IOCallback& cb);

    IOTimer(IOStrand* ios);

    IOTimer(IOStrand* ios, const IOCallback& cb);

public:
    static IOTimerPtr create(IOService *io);
    static IOTimerPtr create(IOService &io);
    static IOTimerPtr create(IOStrand *ios);
    static IOTimerPtr create(IOStrand &ios);

    static IOTimerPtr create(IOService *io, const IOCallback& cb);
    static IOTimerPtr create(IOService &io, const IOCallback& cb);
    static IOTimerPtr create(IOStrand *ios, const IOCallback& cb);
    static IOTimerPtr create(IOStrand &ios, const IOCallback& cb);

    ~IOTimer();

    void setCallback(const IOCallback& cb);

    void wait(const Duration &waitFor);

    void wait(const Duration &waitFor, const IOCallback& cb);

    void cancel();
    Duration expiresFromNow();
};

} // namespace Network
} // namespace Sirikata

#endif //_SIRIKATA_IOTIMER_HPP_