LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
isyncable.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2013 Georg Rudoy
4  *
5  * Boost Software License - Version 1.0 - August 17th, 2003
6  *
7  * Permission is hereby granted, free of charge, to any person or organization
8  * obtaining a copy of the software and accompanying documentation covered by
9  * this license (the "Software") to use, reproduce, display, distribute,
10  * execute, and transmit the Software, and to prepare derivative works of the
11  * Software, and to permit third-parties to whom the Software is furnished to
12  * do so, all subject to the following:
13  *
14  * The copyright notices in the Software and this entire statement, including
15  * the above license grant, this restriction and the following disclaimer,
16  * must be included in all copies of the Software, in whole or in part, and
17  * all derivative works of the Software, unless such copies or derivative
18  * works are solely in the form of machine-executable object code generated by
19  * a source language processor.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24  * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25  * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  **********************************************************************/
29 
30 #ifndef INTERFACES_ISYNCABLE_H
31 #define INTERFACES_ISYNCABLE_H
32 #include <QByteArray>
33 #include <QSet>
34 #include <QList>
35 #include <QMetaType>
36 
37 namespace LeechCraft
38 {
39  namespace Sync
40  {
41  struct Payload
42  {
43  QByteArray Data_;
44  };
45 
46  typedef QList<Payload> Payloads_t;
47 
48  struct Delta
49  {
50  quint32 ID_;
52  };
53 
54  typedef QList<Delta> Deltas_t;
55 
56  typedef QByteArray ChainID_t;
57 
58  typedef QSet<ChainID_t> ChainIDs_t;
59  }
60 }
61 
63 
70 class Q_DECL_EXPORT ISyncable
71 {
72 public:
73  virtual ~ISyncable () {}
74 
75  virtual LeechCraft::Sync::ChainIDs_t AvailableChains () const = 0;
76 
77  virtual LeechCraft::Sync::Payloads_t GetAllDeltas (const LeechCraft::Sync::ChainID_t& chain) const = 0;
78 
79  virtual LeechCraft::Sync::Payloads_t GetNewDeltas (const LeechCraft::Sync::ChainID_t& chain) const = 0;
80 
81  virtual void PurgeNewDeltas (const LeechCraft::Sync::ChainID_t& chain, quint32 numToPurge) = 0;
82 
83  virtual void ApplyDeltas (const LeechCraft::Sync::Payloads_t& deltas,
84  const LeechCraft::Sync::ChainID_t& chain) = 0;
85 
86  virtual void newDeltasAvailable (const LeechCraft::Sync::ChainID_t& chain) = 0;
87 };
88 
89 Q_DECLARE_INTERFACE (ISyncable, "org.Deviant.LeechCraft.Sync.ISyncable/1.0");
90 
91 #endif
QList< Delta > Deltas_t
Definition: isyncable.h:54
QByteArray ChainID_t
Definition: isyncable.h:56
Q_DECLARE_INTERFACE(IColorThemeManager,"org.Deviant.LeechCraft.IColorThemeManager/1.0")
virtual ~ISyncable()
Definition: isyncable.h:73
QSet< ChainID_t > ChainIDs_t
Definition: isyncable.h:58
QList< Payload > Payloads_t
Definition: isyncable.h:46
Interface for plugins that have content/data/settings that can be synchronized via other plugins — sy...
Definition: isyncable.h:70
Q_DECLARE_METATYPE(LeechCraft::IHookProxy_ptr)