68 lines
2.2 KiB
C++
68 lines
2.2 KiB
C++
/*
|
|
Copyright (c) 2005-2009 by Jakob Schroeter <js@camaya.net>
|
|
This file is part of the gloox library. http://camaya.net/gloox
|
|
|
|
This software is distributed under a license. The full license
|
|
agreement can be found in the file LICENSE in this distribution.
|
|
This software may not be copied, modified, sold or distributed
|
|
other than expressed in the named license agreement.
|
|
|
|
This software is distributed without any warranty.
|
|
*/
|
|
|
|
|
|
#ifndef MESSAGESESSIONHANDLER_H__
|
|
#define MESSAGESESSIONHANDLER_H__
|
|
|
|
#include "stanza.h"
|
|
#include "messagesession.h"
|
|
|
|
namespace gloox
|
|
{
|
|
|
|
/**
|
|
* @brief A virtual interface which can be reimplemented to receive incoming message sessions.
|
|
*
|
|
* Derived classes can be registered as MessageSessionHandlers with the Client.
|
|
* If you have enabled automatic MessageSession creation by calling Client::setAutoMessageSession(),
|
|
* handleMessageSession() will be called if a message stanza arrives for which there is no
|
|
* MessageSession yet.
|
|
*
|
|
* @author Jakob Schroeter <js@camaya.net>
|
|
* @since 0.8
|
|
*/
|
|
class GLOOX_API MessageSessionHandler
|
|
{
|
|
public:
|
|
/**
|
|
* Virtual Destructor.
|
|
*/
|
|
virtual ~MessageSessionHandler() {}
|
|
|
|
/**
|
|
* Reimplement this function if you want to be notified about
|
|
* incoming messages by means of automatically created MessageSessions.
|
|
* You receive ownership of the supplied session (@b not the stanza) and
|
|
* are responsible for deleting it at the end of its life.
|
|
*
|
|
* @note Make sure to read the note in ClientBase::registerMessageSessionHandler()
|
|
* regarding the feeding of decorators.
|
|
*
|
|
* @note After receiving a MessageSession your object is the owner and is responsible
|
|
* for the destruction of the session.
|
|
*
|
|
* @note If you don't need the MessageSession, you should not delete it here. You will
|
|
* get an endless loop if you do.
|
|
*
|
|
* @note You should register your MessageHandler here, or else the first message
|
|
* (that caused the MessageSession to be created) may get lost.
|
|
*
|
|
* @param session The new MessageSession.
|
|
*/
|
|
virtual void handleMessageSession( MessageSession* session ) = 0;
|
|
};
|
|
|
|
}
|
|
|
|
#endif // MESSAGESESSIONHANDLER_H__
|