PTLib  Version 2.10.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
XMPP::MUC::Room Class Reference

#include <xmpp_muc.h>

Inheritance diagram for XMPP::MUC::Room:
PObject

Public Member Functions

 Room (C2S::StreamHandler *handler, const JID &jid, const PString &nick)
 Our user in the room.
const UserGetUser () const
const Users & GetOtherUsers () const
virtual PBoolean Enter ()
virtual PBoolean Leave ()
virtual PBoolean SendMessage (const PString &msg)
virtual PBoolean SendMessage (Message &msg)
virtual void OnMessage (Message &msg)
virtual void OnRoomJoined ()
virtual void OnRoomLeft ()
virtual void OnUserAdded (User &user)
virtual void OnUserRemoved (User &user)
virtual void OnUserChanged (User &user)
- Public Member Functions inherited from PObject
virtual ~PObject ()
virtual PObjectClone () const
 Create a copy of the class on the heap.
virtual PINDEX HashFunction () const
 This function yields a hash value required by the PDictionary class.
virtual const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance.
PBoolean IsClass (const char *cls) const
virtual PBoolean InternalIsDescendant (const char *clsName) const
 Determine if the dynamic type of the current instance is a descendent of the specified class.
virtual Comparison Compare (const PObject &obj) const
 Compare the two objects and return their relative rank.
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects.
bool operator== (const PObject &obj) const
 Compare the two objects.
bool operator!= (const PObject &obj) const
 Compare the two objects.
bool operator< (const PObject &obj) const
 Compare the two objects.
bool operator> (const PObject &obj) const
 Compare the two objects.
bool operator<= (const PObject &obj) const
 Compare the two objects.
bool operator>= (const PObject &obj) const
 Compare the two objects.
virtual void PrintOn (ostream &strm) const
 Output the contents of the object to the stream.
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream.

Protected Member Functions

 PDECLARE_SMART_NOTIFIER (C2S::StreamHandler, Room, OnSessionReleased)
 PDECLARE_SMART_NOTIFIER (Message, Room, OnMessage)
 PDECLARE_SMART_NOTIFIER (Presence, Room, OnPresence)
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own.

Protected Attributes

C2S::StreamHandlerm_Handler
BareJID m_RoomJID
User m_User
Users m_OtherUsers
PNotifierList m_MessageHandlers
PNotifierList m_RoomJoinedHandlers
PNotifierList m_RoomLeftHandlers
PNotifierList m_UserAddedHandlers
PNotifierList m_UserRemovedHandlers
PNotifierList m_UserChangedHandlers

Additional Inherited Members

- Public Types inherited from PObject
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
 Result of the comparison operation performed by the Compare() function. More...
- Static Public Member Functions inherited from PObject
static const char * Class ()
 Get the name of the class as a C string.
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect()
- Friends inherited from PObject

Constructor & Destructor Documentation

XMPP::MUC::Room::Room ( C2S::StreamHandler handler,
const JID jid,
const PString nick 
)

Our user in the room.

Parameters
handlerThe C2S stream handler
jidThe room's jid

Member Function Documentation

virtual PBoolean XMPP::MUC::Room::Enter ( )
virtual
const Users& XMPP::MUC::Room::GetOtherUsers ( ) const
inline

References m_OtherUsers.

const User& XMPP::MUC::Room::GetUser ( ) const
inline

References m_User.

virtual PBoolean XMPP::MUC::Room::Leave ( )
virtual
virtual void XMPP::MUC::Room::OnMessage ( Message msg)
virtual
virtual void XMPP::MUC::Room::OnRoomJoined ( )
virtual
virtual void XMPP::MUC::Room::OnRoomLeft ( )
virtual
virtual void XMPP::MUC::Room::OnUserAdded ( User user)
virtual
virtual void XMPP::MUC::Room::OnUserChanged ( User user)
virtual
virtual void XMPP::MUC::Room::OnUserRemoved ( User user)
virtual
XMPP::MUC::Room::PDECLARE_SMART_NOTIFIER ( C2S::StreamHandler  ,
Room  ,
OnSessionReleased   
)
protected
XMPP::MUC::Room::PDECLARE_SMART_NOTIFIER ( Message  ,
Room  ,
OnMessage   
)
protected
XMPP::MUC::Room::PDECLARE_SMART_NOTIFIER ( Presence  ,
Room  ,
OnPresence   
)
protected
virtual PBoolean XMPP::MUC::Room::SendMessage ( const PString msg)
virtual
virtual PBoolean XMPP::MUC::Room::SendMessage ( Message msg)
virtual

Member Data Documentation

C2S::StreamHandler* XMPP::MUC::Room::m_Handler
protected
PNotifierList XMPP::MUC::Room::m_MessageHandlers
protected
Users XMPP::MUC::Room::m_OtherUsers
protected

Referenced by GetOtherUsers().

BareJID XMPP::MUC::Room::m_RoomJID
protected
PNotifierList XMPP::MUC::Room::m_RoomJoinedHandlers
protected
PNotifierList XMPP::MUC::Room::m_RoomLeftHandlers
protected
User XMPP::MUC::Room::m_User
protected

Referenced by GetUser().

PNotifierList XMPP::MUC::Room::m_UserAddedHandlers
protected
PNotifierList XMPP::MUC::Room::m_UserChangedHandlers
protected
PNotifierList XMPP::MUC::Room::m_UserRemovedHandlers
protected

The documentation for this class was generated from the following file: