1/*
2 * libjingle
3 * Copyright 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_RECEIVETASK_H_
29#define TALK_XMPP_RECEIVETASK_H_
30
31#include "talk/xmpp/xmpptask.h"
32
33namespace buzz {
34
35// A base class for receiving stanzas.  Override WantsStanza to
36// indicate that a stanza should be received and ReceiveStanza to
37// process it.  Once started, ReceiveStanza will be called for all
38// stanzas that return true when passed to WantsStanza. This saves
39// you from having to remember how to setup the queueing and the task
40// states, etc.
41class ReceiveTask : public XmppTask {
42 public:
43  explicit ReceiveTask(XmppTaskParentInterface* parent) :
44      XmppTask(parent, XmppEngine::HL_TYPE) {}
45  virtual int ProcessStart();
46
47 protected:
48  virtual bool HandleStanza(const XmlElement* stanza);
49
50  // Return true if the stanza should be received.
51  virtual bool WantsStanza(const XmlElement* stanza) = 0;
52  // Process the received stanza.
53  virtual void ReceiveStanza(const XmlElement* stanza) = 0;
54};
55
56}  // namespace buzz
57
58#endif  // TALK_XMPP_RECEIVETASK_H_
59