← Back to branch summary

~ubuntu-branches/debian/experimental/kopete/experimental

« back to all changes in this revision

Viewing changes to protocols/jabber/googletalk/libjingle/talk/examples/call/voicemailjidrequester.h

  • Committer: Package Import Robot
  • Author(s): Maximiliano Curia
  • Date: 2015-02-24 11:32:57 UTC
  • mfrom: (1.1.41 vivid)
  • Revision ID: package-import@ubuntu.com-20150224113257-gnupg4v7lzz18ij0
Tags: 4:14.12.2-1
* New upstream release (14.12.2).
* Bump Standards-Version to 3.9.6, no changes needed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
protocols/jabber/googletalk/libjingle/talk/examples/call/voicemailjidrequester.h
1
 
/*
2
 
 * libjingle
3
 
 * Copyright 2004--2005, 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
 
// VoicemailJidRequester wraps the requesting of voicemail jids for a user.
29
 
//
30
 
// To request a voicemail jid, we first set off a query to the user's bare jid
31
 
// that looks like this:
32
 
//
33
 
//      <iq type='get'
34
 
//          from='foo@gmail.com/asdf'
35
 
//          to='bar@google.com'
36
 
//          id='1234'>
37
 
//          <query xmlns=' http://jabber.org/protocol/disco#items'
38
 
//                 node='voicemail '/>
39
 
//      </iq>
40
 
//
41
 
// If foo@gmail.com's server supports voicemail, it'll return this, and forward
42
 
// the jid up to phoneapp.  We do not do the second query.
43
 
//
44
 
//      <iq type='result'
45
 
//          from='foo@google.com'
46
 
//          to='bar@google.com/asdf'
47
 
//          id='1234'>
48
 
//          <query xmlns=' http://jabber.org/protocol/disco#items '
49
 
//                 node=' voicemail '>
50
 
//                 <item jid='bar@google.com/voicemail '/>
51
 
//          </query>
52
 
//      </iq>
53
 
//
54
 
// If we get an error, we spin off a new request:
55
 
//
56
 
//      <iq type='get'
57
 
//          from='foo@google.com/asdf'
58
 
//          to='foo@google.com'
59
 
//          id='1234'>
60
 
//          <query xmlns=' http://jabber.org/protocol/disco#items'
61
 
//                 node='outgoingvoicemail '/>
62
 
//      </iq>
63
 
//
64
 
// If both of these return errors, we then forward the request to phoneapp.
65
 
 
66
 
#ifndef TALK_EXAMPLES_CALL_VOICEMAILJIDREQUESTER_H_
67
 
#define TALK_EXAMPLES_CALL_VOICEMAILJIDREQUESTER_H_
68
 
 
69
 
#include "talk/xmpp/xmpptask.h"
70
 
 
71
 
namespace buzz {
72
 
 
73
 
class Task;
74
 
 
75
 
class VoicemailJidRequester : public sigslot::has_slots<>,
76
 
                              public XmppTaskBase {
77
 
 public:
78
 
  VoicemailJidRequester(XmppTaskParentInterface* parent,
79
 
                        const Jid& their_jid, const Jid& my_jid);
80
 
 
81
 
  // Provides the target jid and the voicemail to reach it
82
 
  sigslot::signal2<const Jid&, const Jid&> SignalGotVoicemailJid;
83
 
  sigslot::signal1<const Jid&> SignalVoicemailJidError;
84
 
 
85
 
  virtual int ProcessStart();
86
 
 protected:
87
 
 
88
 
  virtual int Process(int state);
89
 
 
90
 
 private:
91
 
  // The first query (to node='voicemail' has returned an error) - we now spin
92
 
  // off a request to node='outgoingvoicemail')
93
 
  void OnFirstVoicemailJidError(buzz::Jid jid, const XmlElement* xml_element);
94
 
 
95
 
  // The first query (to node='voicemail' has returned a successfully)
96
 
  void OnFirstVoicemailJidSuccess(buzz::Jid jid, const XmlElement* xml_element);
97
 
 
98
 
  // The second query (to node='outgoingvoicemail') has returned an error -
99
 
  // nothing we can do now, just fire our error signal
100
 
  void OnSecondVoicemailJidError(buzz::Jid jid, const XmlElement* xml_element);
101
 
 
102
 
  // The second query (to node='outgoingvoicemail') has returned a successfully
103
 
  void OnSecondVoicemailJidSuccess(buzz::Jid jid,
104
 
                                   const XmlElement* xml_element);
105
 
 
106
 
  // Parse the xml, fire SignalGotVoicemail jid if it was valid (and had a jid)
107
 
  // and return true if it was a valid xml.
108
 
  bool ProcessVoicemailXml(const XmlElement* xml_element);
109
 
 
110
 
  // Send a query to your own jid to get the voicemail jid.  This is used after
111
 
  // the first query fails.
112
 
  void StartSecondQuery();
113
 
 
114
 
  Jid their_jid_;
115
 
 
116
 
  // Your own jid (not the other user's)
117
 
  Jid my_jid_;
118
 
 
119
 
  // A flag indicating whether or not we're done with the query so that we can
120
 
  // set the state correctly in Process(int state)
121
 
  bool done_with_query_;
122
 
};
123
 
}
124
 
 
125
 
#endif  // TALK_EXAMPLES_CALL_VOICEMAILJIDREQUESTER_H_