1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>QXmpp: QXmppStun.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<h1>QXmppStun.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2008-2010 The QXmpp developers</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Author:</span>
<a name="l00005"></a>00005 <span class="comment"> * Jeremy Lainé</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Source:</span>
<a name="l00008"></a>00008 <span class="comment"> * http://code.google.com/p/qxmpp</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * This file is a part of QXmpp library.</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00013"></a>00013 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00014"></a>00014 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00015"></a>00015 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * This library is distributed in the hope that it will be useful,</span>
<a name="l00018"></a>00018 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00019"></a>00019 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00020"></a>00020 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> */</span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="preprocessor">#ifndef QXMPPSTUN_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define QXMPPSTUN_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <QObject></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#include "QXmppLogger.h"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "QXmppJingleIq.h"</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">class </span>QUdpSocket;
<a name="l00033"></a>00033 <span class="keyword">class </span>QTimer;
<a name="l00034"></a>00034
<a name="l00037"></a>00037
<a name="l00038"></a><a class="code" href="classQXmppStunMessage.html">00038</a> <span class="keyword">class </span><a class="code" href="classQXmppStunMessage.html" title="The QXmppStunMessage class represents a STUN message.">QXmppStunMessage</a>
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040 <span class="keyword">public</span>:
<a name="l00041"></a>00041 <a class="code" href="classQXmppStunMessage.html#a37ede2e1c04706c22e6e68529e7c1360" title="Constructs a new QXmppStunMessage.">QXmppStunMessage</a>();
<a name="l00042"></a>00042
<a name="l00043"></a>00043 QByteArray id() <span class="keyword">const</span>;
<a name="l00044"></a>00044 <span class="keywordtype">void</span> setId(<span class="keyword">const</span> QByteArray &<span class="keywordtype">id</span>);
<a name="l00045"></a>00045
<a name="l00046"></a>00046 quint16 type() <span class="keyword">const</span>;
<a name="l00047"></a>00047 <span class="keywordtype">void</span> setType(quint16 type);
<a name="l00048"></a>00048
<a name="l00049"></a>00049 QByteArray <a class="code" href="classQXmppStunMessage.html#a6c451de59923aa3030ad6d293bd773e1">encode</a>(<span class="keyword">const</span> QString &password = QString()) <span class="keyword">const</span>;
<a name="l00050"></a>00050 <span class="keywordtype">bool</span> <a class="code" href="classQXmppStunMessage.html#a22afa02f156e4e14eb080f7cbe33778e">decode</a>(<span class="keyword">const</span> QByteArray &buffer, <span class="keyword">const</span> QString &password = QString(), QStringList *errors = 0);
<a name="l00051"></a>00051 QString toString() <span class="keyword">const</span>;
<a name="l00052"></a>00052 <span class="keyword">static</span> quint16 <a class="code" href="classQXmppStunMessage.html#a224c3b2dff3b3f4a1b5e38a17254b1e8">peekType</a>(<span class="keyword">const</span> QByteArray &buffer);
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="comment">// attributes</span>
<a name="l00055"></a>00055 <span class="keywordtype">int</span> errorCode;
<a name="l00056"></a>00056 QString errorPhrase;
<a name="l00057"></a>00057 quint32 priority;
<a name="l00058"></a>00058 QByteArray iceControlling;
<a name="l00059"></a>00059 QByteArray iceControlled;
<a name="l00060"></a>00060 QHostAddress mappedHost;
<a name="l00061"></a>00061 quint16 mappedPort;
<a name="l00062"></a>00062 QHostAddress otherHost;
<a name="l00063"></a>00063 quint16 otherPort;
<a name="l00064"></a>00064 QHostAddress xorMappedHost;
<a name="l00065"></a>00065 quint16 xorMappedPort;
<a name="l00066"></a>00066 QString software;
<a name="l00067"></a>00067 QString username;
<a name="l00068"></a>00068 <span class="keywordtype">bool</span> useCandidate;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keyword">private</span>:
<a name="l00071"></a>00071 <span class="keywordtype">void</span> setBodyLength(QByteArray &buffer, qint16 length) <span class="keyword">const</span>;
<a name="l00072"></a>00072
<a name="l00073"></a>00073 QByteArray m_id;
<a name="l00074"></a>00074 quint16 m_type;
<a name="l00075"></a>00075 };
<a name="l00076"></a>00076
<a name="l00077"></a>00077
<a name="l00081"></a>00081
<a name="l00082"></a><a class="code" href="classQXmppStunSocket.html">00082</a> <span class="keyword">class </span><a class="code" href="classQXmppStunSocket.html" title="The QXmppStunSocket class represents an UDP socket capable of performing Interactive...">QXmppStunSocket</a> : <span class="keyword">public</span> QObject
<a name="l00083"></a>00083 {
<a name="l00084"></a>00084 Q_OBJECT
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="keyword">public</span>:
<a name="l00087"></a>00087 <a class="code" href="classQXmppStunSocket.html#afeb2f5e111e3d9f02b2f9348d3ab90f3">QXmppStunSocket</a>(<span class="keywordtype">bool</span> iceControlling, QObject *parent=0);
<a name="l00088"></a>00088 ~<a class="code" href="classQXmppStunSocket.html" title="The QXmppStunSocket class represents an UDP socket capable of performing Interactive...">QXmppStunSocket</a>();
<a name="l00089"></a>00089
<a name="l00090"></a>00090 QList<QXmppJingleCandidate> <a class="code" href="classQXmppStunSocket.html#a78f4be4198c6d5849520583fb1783e6c">localCandidates</a>() <span class="keyword">const</span>;
<a name="l00091"></a>00091 QString localUser() <span class="keyword">const</span>;
<a name="l00092"></a>00092 <span class="keywordtype">void</span> setLocalUser(<span class="keyword">const</span> QString &user);
<a name="l00093"></a>00093 QString localPassword() <span class="keyword">const</span>;
<a name="l00094"></a>00094 <span class="keywordtype">void</span> setLocalPassword(<span class="keyword">const</span> QString &password);
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="keywordtype">int</span> <a class="code" href="classQXmppStunSocket.html#a6af839c751ca574a468f038072fa5bac">component</a>() <span class="keyword">const</span>;
<a name="l00097"></a>00097 <span class="keywordtype">void</span> <a class="code" href="classQXmppStunSocket.html#a93a0f8596c3d17b8986e50ca8e89537b">setComponent</a>(<span class="keywordtype">int</span> component);
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keywordtype">bool</span> <a class="code" href="classQXmppStunSocket.html#a381da434a1ccae2ea41b06488aeaab69" title="Adds a remote STUN candidate.">addRemoteCandidate</a>(<span class="keyword">const</span> <a class="code" href="classQXmppJingleCandidate.html" title="The QXmppJingleCandidate class represents a transport candidate as specified by XEP-0176:...">QXmppJingleCandidate</a> &candidate);
<a name="l00100"></a>00100 <span class="keywordtype">void</span> setRemoteUser(<span class="keyword">const</span> QString &user);
<a name="l00101"></a>00101 <span class="keywordtype">void</span> setRemotePassword(<span class="keyword">const</span> QString &password);
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="keywordtype">void</span> <a class="code" href="classQXmppStunSocket.html#a73370c25799c94eec212feee581be20c" title="Closes the socket.">close</a>();
<a name="l00104"></a>00104 <span class="keywordtype">void</span> <a class="code" href="classQXmppStunSocket.html#ad916aeda74d3da61a617f4b78b7c1f41" title="Start ICE connectivity checks.">connectToHost</a>();
<a name="l00105"></a>00105 <span class="keywordtype">bool</span> <a class="code" href="classQXmppStunSocket.html#ae15d8a032f72b272b3e2552cd7e46f07" title="Returns true if ICE negotiation completed, false otherwise.">isConnected</a>() <span class="keyword">const</span>;
<a name="l00106"></a>00106 qint64 <a class="code" href="classQXmppStunSocket.html#a6f8c6ada648c1d696f8feaec87d5d068">writeDatagram</a>(<span class="keyword">const</span> QByteArray &datagram);
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="keyword">private</span> slots:
<a name="l00109"></a>00109 <span class="keywordtype">void</span> checkCandidates();
<a name="l00110"></a>00110 <span class="keywordtype">void</span> readyRead();
<a name="l00111"></a>00111
<a name="l00112"></a>00112 signals:
<a name="l00113"></a>00113 <span class="comment">// This signal is emitted once ICE negotiation succeeds.</span>
<a name="l00114"></a>00114 <span class="keywordtype">void</span> connected();
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="comment">// This signal is emitted when a data packet is received.</span>
<a name="l00117"></a>00117 <span class="keywordtype">void</span> datagramReceived(<span class="keyword">const</span> QByteArray &datagram);
<a name="l00118"></a>00118
<a name="l00120"></a>00120 <span class="keywordtype">void</span> <a class="code" href="classQXmppStunSocket.html#a6ab9431b592646da2aa20e4006ad4532" title="This signal is emitted to send logging messages.">logMessage</a>(<a class="code" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8" title="This enum describes a type of log message.">QXmppLogger::MessageType</a> type, <span class="keyword">const</span> QString &msg);
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="keyword">private</span>:
<a name="l00123"></a>00123 <span class="keyword">class </span>Pair {
<a name="l00124"></a>00124 <span class="keyword">public</span>:
<a name="l00125"></a>00125 Pair();
<a name="l00126"></a>00126 QString toString() <span class="keyword">const</span>;
<a name="l00127"></a>00127
<a name="l00128"></a>00128 QIODevice::OpenMode checked;
<a name="l00129"></a>00129 quint32 priority;
<a name="l00130"></a>00130 <a class="code" href="classQXmppJingleCandidate.html" title="The QXmppJingleCandidate class represents a transport candidate as specified by XEP-0176:...">QXmppJingleCandidate</a> remote;
<a name="l00131"></a>00131 <a class="code" href="classQXmppJingleCandidate.html" title="The QXmppJingleCandidate class represents a transport candidate as specified by XEP-0176:...">QXmppJingleCandidate</a> reflexive;
<a name="l00132"></a>00132 QByteArray transaction;
<a name="l00133"></a>00133 };
<a name="l00134"></a>00134
<a name="l00135"></a>00135 Pair *<a class="code" href="classQXmppStunSocket.html#a381da434a1ccae2ea41b06488aeaab69" title="Adds a remote STUN candidate.">addRemoteCandidate</a>(<span class="keyword">const</span> QHostAddress &host, quint16 port);
<a name="l00136"></a>00136 <span class="keywordtype">void</span> debug(<span class="keyword">const</span> QString &message, <a class="code" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8" title="This enum describes a type of log message.">QXmppLogger::MessageType</a> = <a class="code" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8ad37e67a6433954474cdd1a44ee8d8bae" title="Debugging message.">QXmppLogger::DebugMessage</a>);
<a name="l00137"></a>00137 qint64 writeStun(<span class="keyword">const</span> <a class="code" href="classQXmppStunMessage.html" title="The QXmppStunMessage class represents a STUN message.">QXmppStunMessage</a> &message, QXmppStunSocket::Pair *pair);
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="keywordtype">int</span> m_component;
<a name="l00140"></a>00140
<a name="l00141"></a>00141 QString m_localUser;
<a name="l00142"></a>00142 QString m_localPassword;
<a name="l00143"></a>00143
<a name="l00144"></a>00144 Pair *m_activePair;
<a name="l00145"></a>00145 <span class="keywordtype">bool</span> m_iceControlling;
<a name="l00146"></a>00146 QList<Pair*> m_pairs;
<a name="l00147"></a>00147 QString m_remoteUser;
<a name="l00148"></a>00148 QString m_remotePassword;
<a name="l00149"></a>00149
<a name="l00150"></a>00150 QUdpSocket *m_socket;
<a name="l00151"></a>00151 QTimer *m_timer;
<a name="l00152"></a>00152 };
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="preprocessor">#endif</span>
</pre></div></div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 22 00:44:23 2010 for QXmpp by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|
