libcore/include/sirikata/core/sync/TimeSyncClient.hpp

Go to the documentation of this file.

/*  Sirikata
 *  TimeSyncClient.hpp
 *
 *  Copyright (c) 2010, 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_CORE_SYNC_TIME_SYNC_CLIENT_HPP_
#define _SIRIKATA_CORE_SYNC_TIME_SYNC_CLIENT_HPP_

#include <sirikata/core/service/Context.hpp>
#include <sirikata/core/service/PollingService.hpp>
#include <sirikata/core/ohdp/Service.hpp>

namespace Sirikata {

class SIRIKATA_EXPORT TimeSyncClient : public PollingService {
public:
    typedef std::tr1::function<void()> UpdatedCallback;

    TimeSyncClient(Context* ctx, OHDP::Service* ohdp_service, const SpaceID& space, const Duration& polling_interval, UpdatedCallback cb = 0);
    ~TimeSyncClient();

    // Manage the set of nodes to sync with
    void addNode(const OHDP::NodeID& ss);
    void removeNode(const OHDP::NodeID& ss);

    bool valid() const { return mHasBeenInitialized; }
    const Duration& offset() const { return mOffset; }

private:

    virtual void poll();

    void handleSyncMessage(const OHDP::Endpoint &src, const OHDP::Endpoint &dst, MemoryReference payload);

    Context* mContext;
    OHDP::Port* mPort;

    typedef std::tr1::unordered_set<OHDP::NodeID, OHDP::NodeID::Hasher> SyncServerSet;
    SyncServerSet mServers;

    uint8 mSeqno;
    Time mRequestTimes[256];

    bool mHasBeenInitialized;
    Duration mOffset;

    UpdatedCallback mCB;
}; // class TimeSyncServer

} // namespace Sirikata

#endif //_SIRIKATA_CORE_SYNC_TIME_SYNC_CLIENT_HPP_