doc/html/classQXmppStunSocket.html


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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

<!-- 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: QXmppStunSocket Class Reference</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&nbsp;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><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="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>QXmppStunSocket Class Reference</h1><!-- doxytag: class="QXmppStunSocket" -->
<p>The <a class="el" href="classQXmppStunSocket.html" title="The QXmppStunSocket class represents an UDP socket capable of performing Interactive...">QXmppStunSocket</a> class represents an UDP socket capable of performing Interactive Connectivity Establishment (RFC 5245).  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="QXmppStun_8h_source.html">QXmppStun.h</a>&gt;</code></p>

<p><a href="classQXmppStunSocket-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31d7a6b336f019ba579a811c177116e7"></a><!-- doxytag: member="QXmppStunSocket::connected" ref="a31d7a6b336f019ba579a811c177116e7" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>connected</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a245fcdce8145c1b7a55bbd03a363a15c"></a><!-- doxytag: member="QXmppStunSocket::datagramReceived" ref="a245fcdce8145c1b7a55bbd03a363a15c" args="(const QByteArray &amp;datagram)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>datagramReceived</b> (const QByteArray &amp;datagram)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ab9431b592646da2aa20e4006ad4532"></a><!-- doxytag: member="QXmppStunSocket::logMessage" ref="a6ab9431b592646da2aa20e4006ad4532" args="(QXmppLogger::MessageType type, const QString &amp;msg)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#a6ab9431b592646da2aa20e4006ad4532">logMessage</a> (<a class="el" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8">QXmppLogger::MessageType</a> type, const QString &amp;msg)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This signal is emitted to send logging messages. <br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#afeb2f5e111e3d9f02b2f9348d3ab90f3">QXmppStunSocket</a> (bool iceControlling, QObject *parent=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QList&lt; <a class="el" href="classQXmppJingleCandidate.html">QXmppJingleCandidate</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#a78f4be4198c6d5849520583fb1783e6c">localCandidates</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace6c7a15548de6b04d3a1fe72dbe66c2"></a><!-- doxytag: member="QXmppStunSocket::localUser" ref="ace6c7a15548de6b04d3a1fe72dbe66c2" args="() const " -->
QString&nbsp;</td><td class="memItemRight" valign="bottom"><b>localUser</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa4fe0d8d87ca8905c920f7a29d05bdc"></a><!-- doxytag: member="QXmppStunSocket::setLocalUser" ref="aaa4fe0d8d87ca8905c920f7a29d05bdc" args="(const QString &amp;user)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setLocalUser</b> (const QString &amp;user)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d09eec4926827279815f9ffd1e8c629"></a><!-- doxytag: member="QXmppStunSocket::localPassword" ref="a7d09eec4926827279815f9ffd1e8c629" args="() const " -->
QString&nbsp;</td><td class="memItemRight" valign="bottom"><b>localPassword</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a384854d20290e620ff122d0b7761d565"></a><!-- doxytag: member="QXmppStunSocket::setLocalPassword" ref="a384854d20290e620ff122d0b7761d565" args="(const QString &amp;password)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setLocalPassword</b> (const QString &amp;password)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#a6af839c751ca574a468f038072fa5bac">component</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#a93a0f8596c3d17b8986e50ca8e89537b">setComponent</a> (int component)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a381da434a1ccae2ea41b06488aeaab69"></a><!-- doxytag: member="QXmppStunSocket::addRemoteCandidate" ref="a381da434a1ccae2ea41b06488aeaab69" args="(const QXmppJingleCandidate &amp;candidate)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#a381da434a1ccae2ea41b06488aeaab69">addRemoteCandidate</a> (const <a class="el" href="classQXmppJingleCandidate.html">QXmppJingleCandidate</a> &amp;candidate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a remote STUN candidate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9eda2654cf366f07bd0596584a7b039"></a><!-- doxytag: member="QXmppStunSocket::setRemoteUser" ref="ae9eda2654cf366f07bd0596584a7b039" args="(const QString &amp;user)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setRemoteUser</b> (const QString &amp;user)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54de32810b560d9a8384aaa9b078e952"></a><!-- doxytag: member="QXmppStunSocket::setRemotePassword" ref="a54de32810b560d9a8384aaa9b078e952" args="(const QString &amp;password)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setRemotePassword</b> (const QString &amp;password)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73370c25799c94eec212feee581be20c"></a><!-- doxytag: member="QXmppStunSocket::close" ref="a73370c25799c94eec212feee581be20c" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#a73370c25799c94eec212feee581be20c">close</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Closes the socket. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad916aeda74d3da61a617f4b78b7c1f41"></a><!-- doxytag: member="QXmppStunSocket::connectToHost" ref="ad916aeda74d3da61a617f4b78b7c1f41" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#ad916aeda74d3da61a617f4b78b7c1f41">connectToHost</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start ICE connectivity checks. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae15d8a032f72b272b3e2552cd7e46f07"></a><!-- doxytag: member="QXmppStunSocket::isConnected" ref="ae15d8a032f72b272b3e2552cd7e46f07" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#ae15d8a032f72b272b3e2552cd7e46f07">isConnected</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if ICE negotiation completed, false otherwise. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">qint64&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#a6f8c6ada648c1d696f8feaec87d5d068">writeDatagram</a> (const QByteArray &amp;datagram)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classQXmppStunSocket.html" title="The QXmppStunSocket class represents an UDP socket capable of performing Interactive...">QXmppStunSocket</a> class represents an UDP socket capable of performing Interactive Connectivity Establishment (RFC 5245). </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="afeb2f5e111e3d9f02b2f9348d3ab90f3"></a><!-- doxytag: member="QXmppStunSocket::QXmppStunSocket" ref="afeb2f5e111e3d9f02b2f9348d3ab90f3" args="(bool iceControlling, QObject *parent=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QXmppStunSocket::QXmppStunSocket </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>iceControlling</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">QObject *&nbsp;</td>
          <td class="paramname"> <em>parent</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructs a new <a class="el" href="classQXmppStunSocket.html" title="The QXmppStunSocket class represents an UDP socket capable of performing Interactive...">QXmppStunSocket</a>. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6af839c751ca574a468f038072fa5bac"></a><!-- doxytag: member="QXmppStunSocket::component" ref="a6af839c751ca574a468f038072fa5bac" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int QXmppStunSocket::component </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the component id for the current socket, e.g. 1 for RTP and 2 for RTCP. </p>

</div>
</div>
<a class="anchor" id="a78f4be4198c6d5849520583fb1783e6c"></a><!-- doxytag: member="QXmppStunSocket::localCandidates" ref="a78f4be4198c6d5849520583fb1783e6c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QList&lt; <a class="el" href="classQXmppJingleCandidate.html">QXmppJingleCandidate</a> &gt; QXmppStunSocket::localCandidates </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the list of local HOST CANDIDATES candidates by iterating over the available network interfaces. </p>

</div>
</div>
<a class="anchor" id="a93a0f8596c3d17b8986e50ca8e89537b"></a><!-- doxytag: member="QXmppStunSocket::setComponent" ref="a93a0f8596c3d17b8986e50ca8e89537b" args="(int component)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QXmppStunSocket::setComponent </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>component</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets the component id for the current socket, e.g. 1 for RTP and 2 for RTCP.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>component</em>&nbsp;</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a6f8c6ada648c1d696f8feaec87d5d068"></a><!-- doxytag: member="QXmppStunSocket::writeDatagram" ref="a6f8c6ada648c1d696f8feaec87d5d068" args="(const QByteArray &amp;datagram)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">qint64 QXmppStunSocket::writeDatagram </td>
          <td>(</td>
          <td class="paramtype">const QByteArray &amp;&nbsp;</td>
          <td class="paramname"> <em>datagram</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sends a data packet to the remote party.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>datagram</em>&nbsp;</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="QXmppStun_8h_source.html">QXmppStun.h</a></li>
<li>QXmppStun.cpp</li>
</ul>
</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">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</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:24 2010 for QXmpp by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>