obby::basic_local_document_info< Document, Selector > Class Template Reference

#include <local_document_info.hpp>

Inheritance diagram for obby::basic_local_document_info< Document, Selector >:


Public Types
enum	subscription_state { UNSUBSCRIBED, UNSUBSCRIBING, SUBSCRIBED, SUBSCRIBING }
typedef basic_document_info< Document, Selector >	base_type
typedef base_type::document_type	document_type
typedef basic_local_buffer< Document, Selector >	buffer_type
typedef buffer_type::net_type	net_type
Public Member Functions
	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)
virtual void	subscribe ()=0
virtual void	unsubscribe ()=0
virtual bool	is_subscribed () const
virtual bool	is_subscribed (const user &user) const
virtual subscription_state	get_subscription_state () const=0
	Returns the state of the local user's subscription to this document.
virtual void	obby_session_close ()
	Called when the session has been closed.
const buffer_type &	get_buffer () const
Protected Member Functions
void	session_close_impl ()
net_type &	get_net6 ()
const net_type &	get_net6 () const

Detailed Description

template<typename Document, typename Selector>
class obby::basic_local_document_info< Document, Selector >

Information about a document that is provided without being subscribed to a document.

Definition at line 37 of file local_document_info.hpp.

Member Typedef Documentation

template<typename Document, typename Selector>

typedef basic_document_info<Document, Selector> obby::basic_local_document_info< Document, Selector >::base_type

Reimplemented in obby::basic_client_document_info< Document, Selector >, and obby::basic_host_document_info< Document, Selector >.

Definition at line 41 of file local_document_info.hpp.

template<typename Document, typename Selector>

typedef base_type::document_type obby::basic_local_document_info< Document, Selector >::document_type

Reimplemented from obby::basic_document_info< Document, Selector >.

Reimplemented in obby::basic_client_document_info< Document, Selector >, and obby::basic_host_document_info< Document, Selector >.

Definition at line 42 of file local_document_info.hpp.

template<typename Document, typename Selector>

typedef basic_local_buffer<Document, Selector> obby::basic_local_document_info< Document, Selector >::buffer_type

Reimplemented from obby::basic_document_info< Document, Selector >.

Reimplemented in obby::basic_client_document_info< Document, Selector >, and obby::basic_host_document_info< Document, Selector >.

Definition at line 44 of file local_document_info.hpp.

template<typename Document, typename Selector>

typedef buffer_type::net_type obby::basic_local_document_info< Document, Selector >::net_type

Reimplemented from obby::basic_document_info< Document, Selector >.

Reimplemented in obby::basic_client_document_info< Document, Selector >, and obby::basic_host_document_info< Document, Selector >.

Definition at line 45 of file local_document_info.hpp.

Member Enumeration Documentation

template<typename Document, typename Selector>

enum obby::basic_local_document_info::subscription_state

Enumerator:

UNSUBSCRIBED
UNSUBSCRIBING
SUBSCRIBED
SUBSCRIBING

Reimplemented in obby::basic_client_document_info< Document, Selector >, and obby::basic_host_document_info< Document, Selector >.

Definition at line 47 of file local_document_info.hpp.

Constructor & Destructor Documentation

template<typename Document, typename Selector>

obby::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
	)

Definition at line 128 of file local_document_info.hpp.

template<typename Document, typename Selector>

obby::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
	)

Definition at line 141 of file local_document_info.hpp.

template<typename Document, typename Selector>

obby::basic_local_document_info< Document, Selector >::basic_local_document_info	(	const buffer_type &	buffer,
		net_type &	net,
		const serialise::object &	obj
	)

Definition at line 153 of file local_document_info.hpp.

template<typename Document, typename Selector>

obby::basic_local_document_info< Document, Selector >::basic_local_document_info	(	const buffer_type &	buffer,
		net_type &	net,
		const net6::packet &	init_pack
	)

Definition at line 162 of file local_document_info.hpp.

Member Function Documentation

template<typename Document, typename Selector>

virtual void obby::basic_local_document_info< Document, Selector >::subscribe ( ) [pure virtual]

Sends a subscribe request for the local user. If the subscribe request succeeded, the subscribe_event will be emitted.

Implemented in obby::basic_client_document_info< Document, Selector >, and obby::basic_host_document_info< Document, Selector >.

template<typename Document, typename Selector>

virtual void obby::basic_local_document_info< Document, Selector >::unsubscribe ( ) [pure virtual]

Unsubscribes the local user from this document. signal_unsubscribe will be emitted if the request has been accepted.

Implemented in obby::basic_client_document_info< Document, Selector >, and obby::basic_host_document_info< Document, Selector >.

template<typename Document, typename Selector>

bool obby::basic_local_document_info< Document, Selector >::is_subscribed ( ) const [virtual]

Returns whether the local user is subscribed to this document.

Definition at line 170 of file local_document_info.hpp.

References obby::basic_local_document_info< Document, Selector >::get_buffer(), and obby::basic_document_info< Document, Selector >::is_subscribed().

Referenced by obby::basic_host_document_info< Document, Selector >::get_subscription_state().

template<typename Document, typename Selector>

bool obby::basic_local_document_info< Document, Selector >::is_subscribed ( const user & user ) const [virtual]

Returns whether the given user user is subscribed to this document.

Reimplemented from obby::basic_document_info< Document, Selector >.

Definition at line 177 of file local_document_info.hpp.

References obby::basic_document_info< Document, Selector >::is_subscribed().

template<typename Document, typename Selector>

virtual subscription_state obby::basic_local_document_info< Document, Selector >::get_subscription_state ( ) const [pure virtual]

Returns the state of the local user's subscription to this document.

Implemented in obby::basic_client_document_info< Document, Selector >, and obby::basic_host_document_info< Document, Selector >.

template<typename Document, typename Selector>

void obby::basic_local_document_info< Document, Selector >::obby_session_close ( ) [virtual]

Called when the session has been closed.

Reimplemented from obby::basic_document_info< Document, Selector >.

Reimplemented in obby::basic_client_document_info< Document, Selector >, and obby::basic_host_document_info< Document, Selector >.

Definition at line 183 of file local_document_info.hpp.

References obby::basic_local_document_info< Document, Selector >::session_close_impl().

template<typename Document, typename Selector>

void obby::basic_local_document_info< Document, Selector >::session_close_impl ( ) [protected]

Implementation of the session close callback that does not call the base function.

Reimplemented from obby::basic_document_info< Document, Selector >.

Reimplemented in obby::basic_client_document_info< Document, Selector >, and obby::basic_host_document_info< Document, Selector >.

Definition at line 190 of file local_document_info.hpp.

Referenced by obby::basic_local_document_info< Document, Selector >::obby_session_close().

template<typename Document, typename Selector>

const basic_local_document_info< Document, Selector >::buffer_type & obby::basic_local_document_info< Document, Selector >::get_buffer ( ) const

Returns the buffer this document belongs to.

Reimplemented from obby::basic_document_info< Document, Selector >.

Reimplemented in obby::basic_client_document_info< Document, Selector >, and obby::basic_host_document_info< Document, Selector >.

Definition at line 196 of file local_document_info.hpp.

References obby::basic_document_info< Document, Selector >::get_buffer().

Referenced by obby::basic_local_document_info< Document, Selector >::is_subscribed().

template<typename Document, typename Selector>

basic_local_document_info< Document, Selector >::net_type & obby::basic_local_document_info< Document, Selector >::get_net6 ( ) [protected]

Returns the underlaying net6 object.

Reimplemented from obby::basic_document_info< Document, Selector >.

Reimplemented in obby::basic_client_document_info< Document, Selector >, and obby::basic_host_document_info< Document, Selector >.

Definition at line 203 of file local_document_info.hpp.

References obby::basic_document_info< Document, Selector >::get_net6().

template<typename Document, typename Selector>

const basic_local_document_info< Document, Selector >::net_type & obby::basic_local_document_info< Document, Selector >::get_net6 ( ) const [protected]