Home | History | Annotate | Download | only in xmpp 
      1 /*
      2  * libjingle
      3  * Copyright 2004--2012, 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 THIRD_PARTY_LIBJINGLE_FILES_TALK_XMPP_PRESENCERECEIVETASK_H_
     29 #define THIRD_PARTY_LIBJINGLE_FILES_TALK_XMPP_PRESENCERECEIVETASK_H_
     30 
     31 #include "webrtc/base/sigslot.h"
     32 
     33 #include "talk/xmpp/presencestatus.h"
     34 #include "talk/xmpp/xmpptask.h"
     35 
     36 namespace buzz {
     37 
     38 // A task to receive presence status callbacks from the XMPP server.
     39 class PresenceReceiveTask : public XmppTask {
     40  public:
     41   // Arguments:
     42   //   parent a reference to task interface associated withe the XMPP client.
     43   explicit PresenceReceiveTask(XmppTaskParentInterface* parent);
     44 
     45   // Shuts down the thread associated with this task.
     46   virtual ~PresenceReceiveTask();
     47 
     48   // Starts pulling queued status messages and dispatching them to the
     49   // PresenceUpdate() callback.
     50   virtual int ProcessStart();
     51 
     52   // Slot for presence message callbacks
     53   sigslot::signal1<const PresenceStatus&> PresenceUpdate;
     54 
     55  protected:
     56   // Called by the XMPP engine when presence stanzas are received from the
     57   // server.
     58   virtual bool HandleStanza(const XmlElement * stanza);
     59 
     60  private:
     61   // Handles presence stanzas by converting the data to PresenceStatus
     62   // objects and passing those along to the SignalStatusUpadate() callback.
     63   void HandlePresence(const Jid& from, const XmlElement * stanza);
     64 
     65   // Extracts presence information for the presence stanza sent form the
     66   // server.
     67   static void DecodeStatus(const Jid& from, const XmlElement * stanza,
     68                            PresenceStatus* status);
     69 };
     70 
     71 } // namespace buzz
     72 
     73 #endif // THIRD_PARTY_LIBJINGLE_FILES_TALK_XMPP_PRESENCERECEIVETASK_H_
     74