1/*
2 * libjingle
3 * Copyright 2004--2011, Google Inc.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 *  1. Redistributions of source code must retain the above copyright notice,
9 *     this list of conditions and the following disclaimer.
10 *  2. Redistributions in binary form must reproduce the above copyright notice,
11 *     this list of conditions and the following disclaimer in the documentation
12 *     and/or other materials provided with the distribution.
13 *  3. The name of the author may not be used to endorse or promote products
14 *     derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28#ifndef TALK_XMPP_PUBSUB_TASK_H_
29#define TALK_XMPP_PUBSUB_TASK_H_
30
31#include <map>
32#include <string>
33#include "webrtc/libjingle/xmllite/xmlelement.h"
34#include "talk/xmpp/jid.h"
35#include "talk/xmpp/xmpptask.h"
36
37namespace buzz {
38
39// Base class to help write pubsub tasks.
40// In ProcessStart call SubscribeNode with namespaces of interest along with
41// NodeHandlers.
42// When pubsub notifications arrive and matches the namespace, the NodeHandlers
43// will be called back.
44class PubsubTask : public buzz::XmppTask {
45 public:
46  virtual ~PubsubTask();
47
48 protected:
49  typedef void (PubsubTask::*NodeHandler)(const buzz::XmlElement* node);
50
51  PubsubTask(XmppTaskParentInterface* parent, const buzz::Jid& pubsub_node_jid);
52
53  virtual bool HandleStanza(const buzz::XmlElement* stanza);
54  virtual int ProcessResponse();
55
56  bool SubscribeToNode(const std::string& pubsub_node, NodeHandler handler);
57  void UnsubscribeFromNode(const std::string& pubsub_node);
58
59  // Called when there is an error. Derived class can do what it needs to.
60  virtual void OnPubsubError(const buzz::XmlElement* error_stanza);
61
62 private:
63  typedef std::map<std::string, NodeHandler> NodeSubscriptions;
64
65  void HandlePubsubIqGetResponse(const buzz::XmlElement* pubsub_iq_response);
66  void HandlePubsubEventMessage(const buzz::XmlElement* pubsub_event_message);
67  void HandlePubsubItems(const buzz::XmlElement* items);
68
69  buzz::Jid pubsub_node_jid_;
70  NodeSubscriptions subscribed_nodes_;
71};
72
73}  // namespace buzz
74
75#endif // TALK_XMPP_PUBSUB_TASK_H_
76