libcore/include/sirikata/core/service/Poller.hpp

Go to the documentation of this file.

/*  Sirikata
 *  Poller.hpp
 *
 *  Copyright (c) 2009, Ewen Cheslack-Postava
 *  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_POLLER_HPP_
#define _SIRIKATA_POLLER_HPP_

#include "Service.hpp"
#include <sirikata/core/network/IOService.hpp>
#include <sirikata/core/network/IOStrand.hpp>
#include <sirikata/core/network/IOTimer.hpp>
#include <sirikata/core/util/Time.hpp>

namespace Sirikata {

class SIRIKATA_EXPORT Poller {
public:
    Poller(Network::IOStrand* str, const Network::IOCallback& cb, const char* cb_tag, const Duration& max_rate = Duration::microseconds(0), bool accurate = false);
    virtual ~Poller();

    virtual void start();

    virtual void stop();
private:
    void setupNextTimeout(const Duration& user_time);
    void handleExec(const Network::IOTimerWPtr& timer);

    Network::IOStrand* mStrand;
    Network::IOTimerPtr mTimer;
    Duration mMaxRate;
    bool mAccurate;
    bool mUnschedule;
    Network::IOCallback mCB; // Our callback, just saves us from reconstructing it all the time
    Network::IOCallback mUserCB; // The user's callback
    const char* mCBTag;

#if SIRIKATA_DEBUG
    // Track +1 on start(), -1 on stop()
    int8 mPollerRunCount;
#endif
}; // class Poller

} // namespace Sirikata

#endif //_SIRIKATA_POLLER_HPP_