Tonido::Data::InvitationManager Class Reference

Manages Invitations. More...

List of all members.

Public Types
typedef boost::shared_ptr < InvitationManager >	SharedPtr
Public Member Functions
Ctors & Dtors
	InvitationManager ()
	Ctor.
	~InvitationManager ()
	Dtor.
Invitation Management
Invitation::SharedPtr	invitationGet (const std::string &a_invitationID)
	Get specific Invitation given an ID.
bool	invitationCollectionGetForGroup (Invitation::Collection &a_collection, const Poco::UUID &a_groupID)
	Returns the list of invitations for a group.
Invitation::SharedPtr	invitationGet (const Poco::UUID &a_groupID, const std::string &a_invitePassword)
	Get specific Invitation given a group id and invitation password.
bool	invitationAdd (const Invitation::SharedPtr &a_invitation)
	Add a new Invitation.
bool	invitationRemove (const std::string &a_invitationID)
	Remove a Invitation.
bool	invitationsForGroupRemove (const Poco::UUID &a_groupID)
	Remove Invitations for a specific group.
bool	invitationCollectionGet (Invitation::Collection &a_collection, const std::string &a_invitationType="")
	Returns the list of invitations.
bool	invitationCollectionGet (Invitation::Collection &a_collection, const PeerID &a_peerID, const std::string &a_inviteType, bool a_isInvitingPeer)
	Returns the list of invitations given specific conditions.
bool	invitationDirectAccept (const std::string &a_invitationID)
	Accept Direct Invitation.
Internal Use Only
void	sendInvitationMessage (const Invitation::SharedPtr &a_invitation)
	Sends an Invitation Message.
void	sendAcceptInvitationMessage (const Invitation::SharedPtr &a_invitation)
	Sends an Accept invitation message to the inviter.
void	sendInvitationFailMessage (Message::SharedPtr &args)
	Send Invitation Fail Message.
void	onAcceptInvitationMessage (Message::SharedPtr &args)
	Processes an accept invitation Message.
void	onAcceptInvitationFailMessage (Message::SharedPtr &args)
	Processes an accept invitation fail message.
void	onAcceptInvitationOKMessage (Message::SharedPtr &args)
	Handles a an incoming invitation accepted message.
void	onAcceptInvitationOKOKMessage (Message::SharedPtr &args)
	Handles an incoming inviter accepting our accept invitation message.
void	onGroupInvitationMessage (Message::SharedPtr &args)
	Handles incoming Group invitation message.
void	onGroupInvitationOKMessage (Message::SharedPtr &args)
	Handles an incoming GroupInvitationOK message.
void	processPeerConnect (const PeerID &a_peer)
	Process a Peer Connecting to us.
void	processNetworkOnline ()
	Process Network Online event.
void	onTimer ()
	Process any pending invitations that need to be sent or received.

---

Detailed Description

Manages Invitations.

This class manages incoming and outgoing invitations. Using a timer, if there are pending invitations to be processed, it will periodically do invitation sendouts to remote peers.

   Peer A --- > Group Invitation --> Peer B
                    
         < --- Group Invitation OK <--
                                        
         < --- ACCEPT Invitation <---

         --- > ACCEPT Invitation OK -->

         <--- ACCEPT Invitatation OK OK -->

---

Constructor & Destructor Documentation

Tonido::Data::InvitationManager::InvitationManager

(

void

)

Ctor.

details if needed ...

Tonido::Data::InvitationManager::~InvitationManager

(

void

)

Dtor.

details if needed ...

---

Member Function Documentation

Invitation::SharedPtr Tonido::Data::InvitationManager::invitationGet	(	const Poco::UUID &	a_groupID,
		const std::string &	a_invitePassword
	)

Get specific Invitation given a group id and invitation password.

This is used primarily to verify if an accept invitation message is valid