pubsub.h

/*
  Copyright (c) 2007-2012 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 PUBSUB_H__
#define PUBSUB_H__

#include <map>
#include <string>

#include "gloox.h"
#include "jid.h"

namespace gloox
{
  namespace PubSub
  {

    class Item;

    enum NodeType
    {
      NodeLeaf,                     
      NodeCollection,               
      NodeInvalid                   
    };

    enum AffiliationType
    {
      AffiliationNone,              
      AffiliationPublisher,         
      AffiliationOwner,             
      AffiliationOutcast,           
      AffiliationInvalid            
    };

    enum SubscriptionType
    {
      SubscriptionNone,             
      SubscriptionSubscribed,       
      SubscriptionPending,          
      SubscriptionUnconfigured,     
      SubscriptionInvalid           
    };

    enum EventType
    {
      EventCollection,              
      EventConfigure,               
      EventDelete,                  
      EventItems,                   
      EventItemsRetract,            
      EventPurge,                   
      EventSubscription,            
      EventUnknown                  
    };

    enum SubscriptionObject
    {
      SubscriptionNodes,            
      SubscriptionItems             
    };

    enum AccessModel
    {
      AccessOpen,                   
      AccessPresence,               
      AccessRoster,                 
      AccessAuthorize,              
      AccessWhitelist,              
      AccessDefault                 
    };

    enum PubSubFeature
    {
      FeatureCollections           = 1,     
      FeatureConfigNode            = 1<<1,  
      FeatureCreateAndConfig       = 1<<2,  
      FeatureCreateNodes           = 1<<3,  
      FeatureDeleteAny             = 1<<4,  
      FeatureDeleteNodes           = 1<<5,  
      FeatureGetPending            = 1<<6,  
      FeatureInstantNodes          = 1<<7,  
      FeatureItemIDs               = 1<<8,  
      FeatureLeasedSubscription    = 1<<9,  
      FeatureManageSubscriptions   = 1<<10, 
      FeatureMetaData              = 1<<11, 
      FeatureModifyAffiliations    = 1<<12, 
      FeatureMultiCollection       = 1<<13, 
      FeatureMultiSubscribe        = 1<<14, 
      FeaturePutcastAffiliation    = 1<<15, 
      FeaturePersistentItems       = 1<<16, 
      FeaturePresenceNotifications = 1<<17, 
      FeaturePublish               = 1<<18, 
      FeaturePublisherAffiliation  = 1<<19, 
      FeaturePurgeNodes            = 1<<20, 
      FeatureRetractItems          = 1<<21, 
      FeatureRetrieveAffiliations  = 1<<22, 
      FeatureRetrieveDefault       = 1<<23, 
      FeatureRetrieveItems         = 1<<24, 
      FeatureRetrieveSubscriptions = 1<<25, 
      FeatureSubscribe             = 1<<26, 
      FeatureSubscriptionOptions   = 1<<27, 
      FeatureSubscriptionNotifs    = 1<<28, 
      FeatureUnknown               = 1<<29  
    };

// [Persistent - Notification]
/* Publisher MUST include an &lt;item/&gt; element, which MAY be empty or contain a payload; if item ID is not provided by publisher, it MUST be generated by pubsub service */

// [Persistent - Payload]
/* Publisher MUST include an &lt;item/&gt; element that contains the payload; if item ID is not provided by publisher, it MUST be generated by pubsub service */

// [Transient - Notification]
/* Publisher MUST NOT include an &lt;item/&gt; element (therefore item ID is neither provided nor generated) but the notification will include an empty &lt;items/&gt; element */

// [Transient - Payload]
/* Publisher MUST include an &lt;item/&gt; element that contains the payload, but the item ID is OPTIONAL */

    struct Subscriber
    {
      Subscriber( const JID& _jid,
                  SubscriptionType _type,
                  const std::string& _subid = EmptyString)
        : jid( _jid ), type( _type ), subid( _subid ) {}
      JID jid;
      SubscriptionType type;
      std::string subid;
    };

    struct Affiliate
    {
      Affiliate( const JID& _jid, AffiliationType _type )
        : jid( _jid ), type( _type ) {}
      JID jid;
      AffiliationType type;
    };

    typedef std::list<Subscriber> SubscriberList;
    typedef std::list<Affiliate> AffiliateList;

    struct TrackedInfo
    {
      JID service;
      std::string node;
      std::string item;
      std::string sid;
    };

    struct SubscriptionInfo
    {
      SubscriptionType type;
      JID jid;
      std::string subid;
    };

    typedef std::list<SubscriptionInfo> SubscriptionList;
    typedef std::map<std::string, SubscriptionList> SubscriptionMap;
    typedef std::map<std::string, AffiliationType> AffiliationMap;
    typedef std::list<Item*> ItemList;

  }

}

#endif // PUBSUB_H__