diff options
| author | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
|---|---|---|
| committer | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
| commit | 93adc6aec9ba4671884d9692308b239d3064e553 (patch) | |
| tree | a5906e560045c841577473a9118ef06a39950a73 /doc/html/classQXmppStunSocket.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppStunSocket.html')
| -rw-r--r-- | doc/html/classQXmppStunSocket.html | 236 |
1 files changed, 236 insertions, 0 deletions
diff --git a/doc/html/classQXmppStunSocket.html b/doc/html/classQXmppStunSocket.html new file mode 100644 index 00000000..3666edcf --- /dev/null +++ b/doc/html/classQXmppStunSocket.html @@ -0,0 +1,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 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 List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class 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 <<a class="el" href="QXmppStun_8h_source.html">QXmppStun.h</a>></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 </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 &datagram)" --> +void </td><td class="memItemRight" valign="bottom"><b>datagramReceived</b> (const QByteArray &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 &msg)" --> +void </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 &msg)</td></tr> +<tr><td class="mdescLeft"> </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"> </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< <a class="el" href="classQXmppJingleCandidate.html">QXmppJingleCandidate</a> > </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 </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 &user)" --> +void </td><td class="memItemRight" valign="bottom"><b>setLocalUser</b> (const QString &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 </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 &password)" --> +void </td><td class="memItemRight" valign="bottom"><b>setLocalPassword</b> (const QString &password)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </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 </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 &candidate)" --> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#a381da434a1ccae2ea41b06488aeaab69">addRemoteCandidate</a> (const <a class="el" href="classQXmppJingleCandidate.html">QXmppJingleCandidate</a> &candidate)</td></tr> +<tr><td class="mdescLeft"> </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 &user)" --> +void </td><td class="memItemRight" valign="bottom"><b>setRemoteUser</b> (const QString &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 &password)" --> +void </td><td class="memItemRight" valign="bottom"><b>setRemotePassword</b> (const QString &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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#a73370c25799c94eec212feee581be20c">close</a> ()</td></tr> +<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#ad916aeda74d3da61a617f4b78b7c1f41">connectToHost</a> ()</td></tr> +<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#ae15d8a032f72b272b3e2552cd7e46f07">isConnected</a> () const </td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if ICE negotiation completed, false otherwise. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">qint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunSocket.html#a6f8c6ada648c1d696f8feaec87d5d068">writeDatagram</a> (const QByteArray &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 & 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 </td> + <td class="paramname"> <em>iceControlling</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QObject * </td> + <td class="paramname"> <em>parent</em> = <code>0</code></td><td> </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> ) </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< <a class="el" href="classQXmppJingleCandidate.html">QXmppJingleCandidate</a> > QXmppStunSocket::localCandidates </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </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 </td> + <td class="paramname"> <em>component</em></td> + <td> ) </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> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a6f8c6ada648c1d696f8feaec87d5d068"></a><!-- doxytag: member="QXmppStunSocket::writeDatagram" ref="a6f8c6ada648c1d696f8feaec87d5d068" args="(const QByteArray &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 & </td> + <td class="paramname"> <em>datagram</em></td> + <td> ) </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> </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"> </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:24 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> |