1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/* libobby - Network text editing library
* Copyright (C) 2005, 2006 0x539 dev group
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef _OBBY_LOCAL_DOCUMENT_INFO_HPP_
#define _OBBY_LOCAL_DOCUMENT_INFO_HPP_
#include <net6/local.hpp>
#include "serialise/object.hpp"
#include "document_info.hpp"
namespace obby
{
template<typename Document, typename Selector>
class basic_local_buffer;
/** Information about a document that is provided without being subscribed to
* a document.
*/
template<typename Document, typename Selector>
class basic_local_document_info:
virtual public basic_document_info<Document, Selector>
{
public:
typedef basic_document_info<Document, Selector> base_type;
typedef typename base_type::document_type document_type;
typedef basic_local_buffer<Document, Selector> buffer_type;
typedef typename buffer_type::net_type net_type;
enum subscription_state {
UNSUBSCRIBED,
UNSUBSCRIBING,
SUBSCRIBED,
SUBSCRIBING
};
basic_local_document_info(const buffer_type& buffer,
net_type& net,
const user* owner,
unsigned int id,
const std::string& title,
unsigned int suffix,
const std::string& encoding);
basic_local_document_info(const buffer_type& buffer,
net_type& net,
const user* owner,
unsigned int id,
const std::string& title,
const std::string& encoding);
basic_local_document_info(const buffer_type& buffer,
net_type& net,
const serialise::object& obj);
basic_local_document_info(const buffer_type& buffer,
net_type& net,
const net6::packet& init_pack);
/** Sends a subscribe request for the local user. If the subscribe
* request succeeded, the subscribe_event will be emitted.
*/
virtual void subscribe() = 0;
/** Unsubscribes the local user from this document. signal_unsubscribe
* will be emitted if the request has been accepted.
*/
virtual void unsubscribe() = 0;
/** Returns whether the local user is subscribed to this document.
*/
virtual bool is_subscribed() const;
/** Returns whether the given user <em>user</em> is subscribed to
* this document.
*/
virtual bool is_subscribed(const user& user) const;
/** @brief Returns the state of the local user's subscription to
* this document.
*/
virtual subscription_state get_subscription_state() const = 0;
/** @brief Called when the session has been closed.
*/
virtual void obby_session_close();
protected:
/** Implementation of the session close callback that does not call
* the base function.
*/
void session_close_impl();
public:
/** Returns the buffer this document belongs to.
*/
const buffer_type& get_buffer() const;
protected:
/** Returns the underlaying net6 object.
*/
net_type& get_net6();
/** Returns the underlaying net6 object.
*/
const net_type& get_net6() const;
};
template<typename Document, typename Selector>
basic_local_document_info<Document, Selector>::
basic_local_document_info(const buffer_type& buffer,
net_type& net,
const user* owner,
unsigned int id,
const std::string& title,
unsigned int suffix,
const std::string& encoding):
base_type(buffer, net, owner, id, title, suffix, encoding)
{
}
template<typename Document, typename Selector>
basic_local_document_info<Document, Selector>::
basic_local_document_info(const buffer_type& buffer,
net_type& net,
const user* owner,
unsigned int id,
const std::string& title,
const std::string& encoding):
base_type(buffer, net, owner, id, title, encoding)
{
}
template<typename Document, typename Selector>
basic_local_document_info<Document, Selector>::
basic_local_document_info(const buffer_type& buffer,
net_type& net,
const serialise::object& obj):
base_type(buffer, net, obj)
{
}
template<typename Document, typename Selector>
basic_local_document_info<Document, Selector>::
basic_local_document_info(const buffer_type& buffer,
net_type& net,
const net6::packet& init_pack):
base_type(buffer, net, init_pack)
{
}
template<typename Document, typename Selector>
bool basic_local_document_info<Document, Selector>::is_subscribed() const
{
return base_type::is_subscribed(get_buffer().get_self() );
}
template<typename Document, typename Selector>
bool basic_local_document_info<Document, Selector>::
is_subscribed(const user& user) const
{
return base_type::is_subscribed(user);
}
template<typename Document, typename Selector>
void basic_local_document_info<Document, Selector>::obby_session_close()
{
session_close_impl();
basic_document_info<Document, Selector>::session_close_impl();
}
template<typename Document, typename Selector>
void basic_local_document_info<Document, Selector>::session_close_impl()
{
}
template<typename Document, typename Selector>
const typename basic_local_document_info<Document, Selector>::buffer_type&
basic_local_document_info<Document, Selector>::get_buffer() const
{
return dynamic_cast<const buffer_type&>(base_type::get_buffer() );
}
template<typename Document, typename Selector>
typename basic_local_document_info<Document, Selector>::net_type&
basic_local_document_info<Document, Selector>::get_net6()
{
return dynamic_cast<net_type&>(base_type::get_net6() );
}
template<typename Document, typename Selector>
const typename basic_local_document_info<Document, Selector>::net_type&
basic_local_document_info<Document, Selector>::get_net6() const
{
return dynamic_cast<const net_type&>(base_type::get_net6() );
}
} // namespace obby
#endif // _OBBY_LOCAL_DOCUMENT_INFO_HPP_
|
