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/classQXmppStunMessage.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppStunMessage.html')
| -rw-r--r-- | doc/html/classQXmppStunMessage.html | 225 |
1 files changed, 225 insertions, 0 deletions
diff --git a/doc/html/classQXmppStunMessage.html b/doc/html/classQXmppStunMessage.html new file mode 100644 index 00000000..18ec0c4a --- /dev/null +++ b/doc/html/classQXmppStunMessage.html @@ -0,0 +1,225 @@ +<!-- 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: QXmppStunMessage 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>QXmppStunMessage Class Reference</h1><!-- doxytag: class="QXmppStunMessage" --> +<p>The <a class="el" href="classQXmppStunMessage.html" title="The QXmppStunMessage class represents a STUN message.">QXmppStunMessage</a> class represents a STUN message. +<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="classQXmppStunMessage-members.html">List of all members.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37ede2e1c04706c22e6e68529e7c1360"></a><!-- doxytag: member="QXmppStunMessage::QXmppStunMessage" ref="a37ede2e1c04706c22e6e68529e7c1360" args="()" --> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunMessage.html#a37ede2e1c04706c22e6e68529e7c1360">QXmppStunMessage</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classQXmppStunMessage.html" title="The QXmppStunMessage class represents a STUN message.">QXmppStunMessage</a>. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a785ce8d7f2b48d966638dadadd326418"></a><!-- doxytag: member="QXmppStunMessage::id" ref="a785ce8d7f2b48d966638dadadd326418" args="() const " --> +QByteArray </td><td class="memItemRight" valign="bottom"><b>id</b> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b7567254dcb65488dcf880393f85a35"></a><!-- doxytag: member="QXmppStunMessage::setId" ref="a8b7567254dcb65488dcf880393f85a35" args="(const QByteArray &id)" --> +void </td><td class="memItemRight" valign="bottom"><b>setId</b> (const QByteArray &id)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa832e9e8a000d51bc63ea3eeab8d30d4"></a><!-- doxytag: member="QXmppStunMessage::type" ref="aa832e9e8a000d51bc63ea3eeab8d30d4" args="() const " --> +quint16 </td><td class="memItemRight" valign="bottom"><b>type</b> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab06d151e5fec4602c34a7f23441046a8"></a><!-- doxytag: member="QXmppStunMessage::setType" ref="ab06d151e5fec4602c34a7f23441046a8" args="(quint16 type)" --> +void </td><td class="memItemRight" valign="bottom"><b>setType</b> (quint16 type)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunMessage.html#a6c451de59923aa3030ad6d293bd773e1">encode</a> (const QString &password=QString()) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunMessage.html#a22afa02f156e4e14eb080f7cbe33778e">decode</a> (const QByteArray &buffer, const QString &password=QString(), QStringList *errors=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe7da89583a9403298b37ca79c9b2836"></a><!-- doxytag: member="QXmppStunMessage::toString" ref="abe7da89583a9403298b37ca79c9b2836" args="() const " --> +QString </td><td class="memItemRight" valign="bottom"><b>toString</b> () const </td></tr> +<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static quint16 </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppStunMessage.html#a224c3b2dff3b3f4a1b5e38a17254b1e8">peekType</a> (const QByteArray &buffer)</td></tr> +<tr><td colspan="2"><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa69cb477f61930d015165d93a03d7c02"></a><!-- doxytag: member="QXmppStunMessage::errorCode" ref="aa69cb477f61930d015165d93a03d7c02" args="" --> +int </td><td class="memItemRight" valign="bottom"><b>errorCode</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae04434ab8ab89268086005f4df926598"></a><!-- doxytag: member="QXmppStunMessage::errorPhrase" ref="ae04434ab8ab89268086005f4df926598" args="" --> +QString </td><td class="memItemRight" valign="bottom"><b>errorPhrase</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a154cddf976819eb5d463cb770297fd9f"></a><!-- doxytag: member="QXmppStunMessage::priority" ref="a154cddf976819eb5d463cb770297fd9f" args="" --> +quint32 </td><td class="memItemRight" valign="bottom"><b>priority</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae88c59938395c5b390067106fb216b76"></a><!-- doxytag: member="QXmppStunMessage::iceControlling" ref="ae88c59938395c5b390067106fb216b76" args="" --> +QByteArray </td><td class="memItemRight" valign="bottom"><b>iceControlling</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade171c107199557197fa68a845fd452d"></a><!-- doxytag: member="QXmppStunMessage::iceControlled" ref="ade171c107199557197fa68a845fd452d" args="" --> +QByteArray </td><td class="memItemRight" valign="bottom"><b>iceControlled</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5bbc2bdd9d6079a89b67d8311ccd5bb"></a><!-- doxytag: member="QXmppStunMessage::mappedHost" ref="ac5bbc2bdd9d6079a89b67d8311ccd5bb" args="" --> +QHostAddress </td><td class="memItemRight" valign="bottom"><b>mappedHost</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a1263c7e88abb3110d5e864372e3335"></a><!-- doxytag: member="QXmppStunMessage::mappedPort" ref="a7a1263c7e88abb3110d5e864372e3335" args="" --> +quint16 </td><td class="memItemRight" valign="bottom"><b>mappedPort</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa52ac475e9c546dc10672568092ace7d"></a><!-- doxytag: member="QXmppStunMessage::otherHost" ref="aa52ac475e9c546dc10672568092ace7d" args="" --> +QHostAddress </td><td class="memItemRight" valign="bottom"><b>otherHost</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9af8b89c2f6d72e6792de6a47c544a56"></a><!-- doxytag: member="QXmppStunMessage::otherPort" ref="a9af8b89c2f6d72e6792de6a47c544a56" args="" --> +quint16 </td><td class="memItemRight" valign="bottom"><b>otherPort</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5628be0c50b5522ebdc76d155a9276fc"></a><!-- doxytag: member="QXmppStunMessage::xorMappedHost" ref="a5628be0c50b5522ebdc76d155a9276fc" args="" --> +QHostAddress </td><td class="memItemRight" valign="bottom"><b>xorMappedHost</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0328a3e0f9170dff4f86a22bf6b1f0d9"></a><!-- doxytag: member="QXmppStunMessage::xorMappedPort" ref="a0328a3e0f9170dff4f86a22bf6b1f0d9" args="" --> +quint16 </td><td class="memItemRight" valign="bottom"><b>xorMappedPort</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa2b070aa4376f109a7985306ac94c0d"></a><!-- doxytag: member="QXmppStunMessage::software" ref="aaa2b070aa4376f109a7985306ac94c0d" args="" --> +QString </td><td class="memItemRight" valign="bottom"><b>software</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68f85e05ad9e2b393eb19ebd8887b10a"></a><!-- doxytag: member="QXmppStunMessage::username" ref="a68f85e05ad9e2b393eb19ebd8887b10a" args="" --> +QString </td><td class="memItemRight" valign="bottom"><b>username</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3bf400bf8ccc8b21378c95f02c8a854"></a><!-- doxytag: member="QXmppStunMessage::useCandidate" ref="aa3bf400bf8ccc8b21378c95f02c8a854" args="" --> +bool </td><td class="memItemRight" valign="bottom"><b>useCandidate</b></td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>The <a class="el" href="classQXmppStunMessage.html" title="The QXmppStunMessage class represents a STUN message.">QXmppStunMessage</a> class represents a STUN message. </p> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a22afa02f156e4e14eb080f7cbe33778e"></a><!-- doxytag: member="QXmppStunMessage::decode" ref="a22afa02f156e4e14eb080f7cbe33778e" args="(const QByteArray &buffer, const QString &password=QString(), QStringList *errors=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppStunMessage::decode </td> + <td>(</td> + <td class="paramtype">const QByteArray & </td> + <td class="paramname"> <em>buffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>password</em> = <code>QString()</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QStringList * </td> + <td class="paramname"> <em>errors</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>Decodes a <a class="el" href="classQXmppStunMessage.html" title="The QXmppStunMessage class represents a STUN message.">QXmppStunMessage</a> and checks its integrity using the given password.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td></td></tr> + <tr><td valign="top"></td><td valign="top"><em>password</em> </td><td></td></tr> + </table> + </dd> +</dl> + +<p><p>ICE-CONTROLLING</p> +<p>ICE-CONTROLLED </p> +</p> + +</div> +</div> +<a class="anchor" id="a6c451de59923aa3030ad6d293bd773e1"></a><!-- doxytag: member="QXmppStunMessage::encode" ref="a6c451de59923aa3030ad6d293bd773e1" args="(const QString &password=QString()) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QByteArray QXmppStunMessage::encode </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>password</em> = <code>QString()</code></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Encodes the current <a class="el" href="classQXmppStunMessage.html" title="The QXmppStunMessage class represents a STUN message.">QXmppStunMessage</a>, optionally calculating the message integrity attribute using the given password.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>password</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a224c3b2dff3b3f4a1b5e38a17254b1e8"></a><!-- doxytag: member="QXmppStunMessage::peekType" ref="a224c3b2dff3b3f4a1b5e38a17254b1e8" args="(const QByteArray &buffer)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">quint16 QXmppStunMessage::peekType </td> + <td>(</td> + <td class="paramtype">const QByteArray & </td> + <td class="paramname"> <em>buffer</em></td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>If the given packet looks like a STUN message, returns the message type, otherwise returns 0.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>buffer</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> |