blob: 56f2c6e7f84bab382f4761d9447ea65ce9b45f30 [file] [log] [blame]
Zhenkai Zhu8d935c82012-03-06 10:44:12 -08001/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil -*- */
2/*
3 * Copyright (c) 2012 University of California, Los Angeles
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Author: Zhenkai Zhu <zhenkai@cs.ucla.edu>
19 * 卞超轶 Chaoyi Bian <bcy@pku.edu.cn>
20 * Alexander Afanasyev <alexander.afanasyev@ucla.edu>
21 */
22
Zhenkai Zhu1ac6f802012-03-06 17:40:27 -080023#ifndef SYNC_APP_WRAPPER_H
24#define SYNC_APP_WRAPPER_H
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080025#include <boost/shared_ptr.hpp>
26#include <boost/function.hpp>
27#include "sync-ccnx-wrapper.h"
28#include "sync-interest-table.h"
29#include "sync-data-buffer.h"
30#include "sync-diff-state.h"
31#include "sync-full-state.h"
32
33namespace Sync {
34
35/**
36 * \ingroup sync
Zhenkai Zhuaae81522012-03-06 11:05:44 -080037 * @brief A wrapper for SyncApp, which handles ccnx related things (process
38 * interests and data)
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080039 */
40class SyncAppWrapper
41{
42public:
Zhenkai Zhu46b26a12012-03-06 13:51:16 -080043 /**
44 * @brief constructor for this class;
45 * @param syncPrefix the name prefix to use for the Sync Interest
46 * @param fetch the fetch function, which will be called to actually fetch
47 * the app data when new remote names are learned
48 */
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080049 SyncAppWrapper(std::string syncPrefix, boost::function<void (string, long,
50 long)> fetch);
Zhenkai Zhu46b26a12012-03-06 13:51:16 -080051
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080052 ~SyncAppWrapper();
53 /**
54 * a wrapper for the same func in SyncApp
55 */
56 void addLocalNames(std::string prefix, long seq);
Zhenkai Zhu46b26a12012-03-06 13:51:16 -080057
58 /**
59 * @brief respond to the Sync Interest; a lot of logic needs to go in here
60 * @param interest the Sync Interest in string format
61 */
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080062 void respondSyncInterest(std::string interest);
Zhenkai Zhu46b26a12012-03-06 13:51:16 -080063
64 /**
65 * @brief process the fetched sync data
66 * @param dataBuffer the sync data
67 */
68 void processSyncData(boost::shared_ptr<DataBuffer> dataBuffer);
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080069
70private:
71 sendSyncInterest();
72
73private:
74 boost::shared_ptr<CcnxWrapper> m_ccnxHandle;
75 boost::shared_ptr<SyncApp> m_syncApp;
76 boost::function<void (string, long, long)> m_fetch;
77 SyncInterestTable m_syncInterestTable;
78 std::string m_syncPrefix;
79};
80
81
82} // Sync
83
Zhenkai Zhu1ac6f802012-03-06 17:40:27 -080084#endif // SYNC_APP_WRAPPER_H