webrtc/talk/xmpp/receivetask.h

59 lines
2.4 KiB
C++

/*
* libjingle
* Copyright 2011, Google Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef TALK_XMPP_RECEIVETASK_H_
#define TALK_XMPP_RECEIVETASK_H_
#include "talk/xmpp/xmpptask.h"
namespace buzz {
// A base class for receiving stanzas. Override WantsStanza to
// indicate that a stanza should be received and ReceiveStanza to
// process it. Once started, ReceiveStanza will be called for all
// stanzas that return true when passed to WantsStanza. This saves
// you from having to remember how to setup the queueing and the task
// states, etc.
class ReceiveTask : public XmppTask {
public:
explicit ReceiveTask(XmppTaskParentInterface* parent) :
XmppTask(parent, XmppEngine::HL_TYPE) {}
virtual int ProcessStart();
protected:
virtual bool HandleStanza(const XmlElement* stanza);
// Return true if the stanza should be received.
virtual bool WantsStanza(const XmlElement* stanza) = 0;
// Process the received stanza.
virtual void ReceiveStanza(const XmlElement* stanza) = 0;
};
} // namespace buzz
#endif // TALK_XMPP_RECEIVETASK_H_