obby::basic_host_document_info

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

#include <host_document_info.hpp>

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

obby::basic_local_document_info< Document, Selector > obby::basic_server_document_info< Document, Selector > obby::basic_document_info< Document, Selector > obby::basic_document_info< Document, Selector > List of all members.

Public Types

typedef basic_document_info<
Document, Selector > 		base_type
typedef basic_local_document_info<
Document, Selector > 		base_local_type
typedef basic_server_document_info<
Document, Selector > 		base_server_type
typedef base_server_type::document_type document_type
typedef basic_host_buffer<
Document, Selector > 		buffer_type
typedef buffer_type::net_type net_type
typedef base_local_type::subscription_state subscription_state

Public Member Functions

 basic_host_document_info (const buffer_type &buffer, net_type &net, const user *owner, unsigned int id, const std::string &title, const std::string &encoding, const std::string &content)
 basic_host_document_info (const buffer_type &buffer, net_type &net, const serialise::object &obj)
virtual void insert (position pos, const std::string &text)
virtual void erase (position pos, position len)
virtual void rename (const std::string &new_title)
virtual void subscribe ()
virtual void unsubscribe ()
virtual subscription_state get_subscription_state () const
 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

virtual void user_subscribe (const user &user)
virtual void user_unsubscribe (const user &user)
virtual void session_close_impl ()
 Implementation of the session close callback that does not call the base function.
net_type & get_net6 ()
const net_type & get_net6 () const

Detailed Description

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

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

Definition at line 36 of file host_document_info.hpp.

Member Typedef Documentation

template<typename Document, typename Selector>
typedef basic_document_info<Document, Selector> obby::basic_host_document_info< Document, Selector >::base_type

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

Definition at line 41 of file host_document_info.hpp.

template<typename Document, typename Selector>
typedef basic_local_document_info<Document, Selector> obby::basic_host_document_info< Document, Selector >::base_local_type

Definition at line 42 of file host_document_info.hpp.

template<typename Document, typename Selector>
typedef basic_server_document_info<Document, Selector> obby::basic_host_document_info< Document, Selector >::base_server_type

Definition at line 43 of file host_document_info.hpp.

template<typename Document, typename Selector>
typedef base_server_type::document_type obby::basic_host_document_info< Document, Selector >::document_type

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

Definition at line 45 of file host_document_info.hpp.

template<typename Document, typename Selector>
typedef basic_host_buffer<Document, Selector> obby::basic_host_document_info< Document, Selector >::buffer_type

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

Definition at line 47 of file host_document_info.hpp.

template<typename Document, typename Selector>
typedef buffer_type::net_type obby::basic_host_document_info< Document, Selector >::net_type

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

Definition at line 48 of file host_document_info.hpp.

template<typename Document, typename Selector>
typedef base_local_type::subscription_state obby::basic_host_document_info< Document, Selector >::subscription_state

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

Definition at line 50 of file host_document_info.hpp.

Constructor & Destructor Documentation

template<typename Document, typename Selector>
obby::basic_host_document_info< Document, Selector >::basic_host_document_info ( const buffer_type &  buffer,
net_type &  net,
const user *  owner,
unsigned int  id,
const std::string &  title,
const std::string &  encoding,
const std::string &  content 
)

Definition at line 126 of file host_document_info.hpp.

References obby::basic_server_document_info< Document, Selector >::m_jupiter.

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

Definition at line 147 of file host_document_info.hpp.

Member Function Documentation

template<typename Document, typename Selector>
void obby::basic_host_document_info< Document, Selector >::insert ( position  pos,
const std::string &  text 
) [virtual]

Inserts the given text at the given position into the document.

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

Definition at line 158 of file host_document_info.hpp.

References obby::basic_host_document_info< Document, Selector >::get_buffer(), obby::basic_host_buffer< Document, Selector >::get_self(), and obby::basic_server_document_info< Document, Selector >::insert_impl().

template<typename Document, typename Selector>
void obby::basic_host_document_info< Document, Selector >::erase ( position  pos,
position  len 
) [virtual]

Erases the given range from the document.

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

Definition at line 168 of file host_document_info.hpp.

References obby::basic_server_document_info< Document, Selector >::erase_impl(), and obby::basic_host_document_info< Document, Selector >::get_buffer().

template<typename Document, typename Selector>
void obby::basic_host_document_info< Document, Selector >::rename ( const std::string &  new_title  )  [virtual]

Renames the current document.

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

Definition at line 176 of file host_document_info.hpp.

References obby::basic_host_document_info< Document, Selector >::get_buffer(), and obby::basic_server_document_info< Document, Selector >::rename_impl().

template<typename Document, typename Selector>
void obby::basic_host_document_info< Document, Selector >::subscribe (  )  [virtual]

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

Implements obby::basic_local_document_info< Document, Selector >.

Definition at line 184 of file host_document_info.hpp.

References obby::basic_server_document_info< Document, Selector >::broadcast_subscription(), obby::basic_host_document_info< Document, Selector >::get_buffer(), obby::basic_host_buffer< Document, Selector >::get_self(), obby::basic_document_info< Document, Selector >::m_net, and obby::basic_host_document_info< Document, Selector >::user_subscribe().

template<typename Document, typename Selector>
void obby::basic_host_document_info< Document, Selector >::unsubscribe (  )  [virtual]

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

Implements obby::basic_local_document_info< Document, Selector >.

Definition at line 194 of file host_document_info.hpp.

References obby::basic_server_document_info< Document, Selector >::broadcast_unsubscription(), obby::basic_host_document_info< Document, Selector >::get_buffer(), obby::basic_host_buffer< Document, Selector >::get_self(), obby::basic_document_info< Document, Selector >::m_net, and obby::basic_host_document_info< Document, Selector >::user_unsubscribe().

template<typename Document, typename Selector>
basic_host_document_info< Document, Selector >::subscription_state obby::basic_host_document_info< Document, Selector >::get_subscription_state (  )  const [virtual]

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

Implements obby::basic_local_document_info< Document, Selector >.

Definition at line 205 of file host_document_info.hpp.

References obby::basic_local_document_info< Document, Selector >::is_subscribed(), obby::basic_local_document_info< Document, Selector >::SUBSCRIBED, and obby::basic_local_document_info< Document, Selector >::UNSUBSCRIBED.

template<typename Document, typename Selector>
void obby::basic_host_document_info< Document, Selector >::obby_session_close (  )  [virtual]

Called when the session has been closed.

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

Definition at line 250 of file host_document_info.hpp.

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

template<typename Document, typename Selector>
void obby::basic_host_document_info< Document, Selector >::user_subscribe ( const user &  user  )  [protected, virtual]

Internally subscribes a user to this document.

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

Definition at line 216 of file host_document_info.hpp.

References obby::basic_host_document_info< Document, Selector >::get_buffer(), obby::basic_server_document_info< Document, Selector >::m_jupiter, and obby::basic_document_info< Document, Selector >::user_subscribe().

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

template<typename Document, typename Selector>
void obby::basic_host_document_info< Document, Selector >::user_unsubscribe ( const user &  user  )  [protected, virtual]

Internally unsubscribes a user from this document.

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

Definition at line 236 of file host_document_info.hpp.

References obby::basic_host_document_info< Document, Selector >::get_buffer(), obby::basic_server_document_info< Document, Selector >::m_jupiter, and obby::basic_document_info< Document, Selector >::user_unsubscribe().

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

template<typename Document, typename Selector>
void obby::basic_host_document_info< Document, Selector >::session_close_impl (  )  [protected, virtual]

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

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

Definition at line 258 of file host_document_info.hpp.

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

template<typename Document, typename Selector>
const basic_host_document_info< Document, Selector >::buffer_type & obby::basic_host_document_info< Document, Selector >::get_buffer (  )  const

Returns the buffer to which this document_info belongs.

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

Definition at line 264 of file host_document_info.hpp.

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

Referenced by obby::basic_host_document_info< Document, Selector >::erase(), obby::basic_host_document_info< Document, Selector >::insert(), obby::basic_host_document_info< Document, Selector >::rename(), obby::basic_host_document_info< Document, Selector >::subscribe(), obby::basic_host_document_info< Document, Selector >::unsubscribe(), obby::basic_host_document_info< Document, Selector >::user_subscribe(), and obby::basic_host_document_info< Document, Selector >::user_unsubscribe().

template<typename Document, typename Selector>
basic_host_document_info< Document, Selector >::net_type & obby::basic_host_document_info< Document, Selector >::get_net6 (  )  [protected]

Returns the underlaying net6 object.

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

Definition at line 271 of file host_document_info.hpp.

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

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

Returns the underlaying net6 object.

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

Definition at line 278 of file host_document_info.hpp.

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

The documentation for this class was generated from the following file:
Generated on Fri Jan 11 10:01:33 2008 for obby by  doxygen 1.5.1