Chat-O-Matic/libs/libgloox/presencehandler.h

/*
  Copyright (c) 2004-2015 by Jakob Schröter <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 PRESENCEHANDLER_H__
#define PRESENCEHANDLER_H__

#include "presence.h"

namespace gloox
{

  /**
   * @brief A virtual interface which can be reimplemented to receive presence stanzas.
   *
   * Derived classes can be registered as PresenceHandlers with the Client.
   * Upon an incoming Presence packet @ref handlePresence() will be called.
   * @author Jakob Schröter <js@camaya.net>
   */
  class GLOOX_API PresenceHandler
  {
    public:
      /**
       * Virtual Destructor.
       */
      virtual ~PresenceHandler() {}

      /**
       * Reimplement this function if you want to be updated on
       * incoming presence notifications.
       * @param presence The complete stanza.
       * @since 1.0
       */
      virtual void handlePresence( const Presence& presence ) = 0;

  };

}

#endif // PRESENCEHANDLER_H__