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/classQXmppTransferManager.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppTransferManager.html')
| -rw-r--r-- | doc/html/classQXmppTransferManager.html | 335 |
1 files changed, 335 insertions, 0 deletions
diff --git a/doc/html/classQXmppTransferManager.html b/doc/html/classQXmppTransferManager.html new file mode 100644 index 00000000..c8b7d190 --- /dev/null +++ b/doc/html/classQXmppTransferManager.html @@ -0,0 +1,335 @@ +<!-- 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: QXmppTransferManager 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>QXmppTransferManager Class Reference<br/> +<small> +[<a class="el" href="group__Managers.html">Managers</a>]</small> +</h1><!-- doxytag: class="QXmppTransferManager" --> +<p>The <a class="el" href="classQXmppTransferManager.html" title="The QXmppTransferManager class provides support for sending and receiving files.">QXmppTransferManager</a> class provides support for sending and receiving files. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="QXmppTransferManager_8h_source.html">QXmppTransferManager.h</a>></code></p> + +<p><a href="classQXmppTransferManager-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferManager.html#aace45e4f982075846fc8e13aa5691757">fileReceived</a> (<a class="el" href="classQXmppTransferJob.html">QXmppTransferJob</a> *offer)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferManager.html#a3126852f4be7c0d76d34d144e9379688">finished</a> (<a class="el" href="classQXmppTransferJob.html">QXmppTransferJob</a> *job)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b0e90dfe01189ec9e4ee05bb3702d5b"></a><!-- doxytag: member="QXmppTransferManager::logMessage" ref="a7b0e90dfe01189ec9e4ee05bb3702d5b" args="(QXmppLogger::MessageType type, const QString &msg)" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferManager.html#a7b0e90dfe01189ec9e4ee05bb3702d5b">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"><a class="anchor" id="abed3ec4ef1d8f933804c1bba24212bf5"></a><!-- doxytag: member="QXmppTransferManager::QXmppTransferManager" ref="abed3ec4ef1d8f933804c1bba24212bf5" args="(QXmppStream *stream, QObject *parent=0)" --> + </td><td class="memItemRight" valign="bottom"><b>QXmppTransferManager</b> (QXmppStream *stream, QObject *parent=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppTransferJob.html">QXmppTransferJob</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferManager.html#adce4271c634320724d044c0678b5dca7">sendFile</a> (const QString &jid, const QString &fileName, const QString &sid=QString())</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppTransferJob.html">QXmppTransferJob</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferManager.html#a9e08182cdd6f2df3c2d3c19bb9660d24">sendFile</a> (const QString &jid, QIODevice *device, const QXmppTransferFileInfo &fileInfo, const QString &sid=QString())</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferManager.html#aab49bb20e1f0ab52a214d41f127ef19e">proxy</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferManager.html#ad7d0f0496c85b85b448010d8a3c86d23">setProxy</a> (const QString &proxyJid)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferManager.html#ab905005b46b50707ef476bb8ecca5dfe">proxyOnly</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferManager.html#a46b2fc83d7773ae755e04a775694b5b8">setProxyOnly</a> (bool proxyOnly)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QXmppTransferJob::Methods </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferManager.html#a0247768bf90d68e47fe18a75a5659f5c">supportedMethods</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppTransferManager.html#a1a6894de4393135f7f80488f180a6ea2">setSupportedMethods</a> (QXmppTransferJob::Methods methods)</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>The <a class="el" href="classQXmppTransferManager.html" title="The QXmppTransferManager class provides support for sending and receiving files.">QXmppTransferManager</a> class provides support for sending and receiving files. </p> +<p>Stream initiation is performed as described in XEP-0095: Stream Initiation and XEP-0096: SI File Transfer. The actual file transfer is then performed using either XEP-0065: SOCKS5 Bytestreams or XEP-0047: In-Band Bytestreams. </p> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="aace45e4f982075846fc8e13aa5691757"></a><!-- doxytag: member="QXmppTransferManager::fileReceived" ref="aace45e4f982075846fc8e13aa5691757" args="(QXmppTransferJob *offer)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppTransferManager::fileReceived </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQXmppTransferJob.html">QXmppTransferJob</a> * </td> + <td class="paramname"> <em>offer</em></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted when a new file transfer offer is received.</p> +<p>To accept the transfer job, call the job's <a class="el" href="classQXmppTransferJob.html#aeb89d694c0f604dd7c955ceeb5e4347d">QXmppTransferJob::accept()</a> method. To refuse the transfer job, call the job's <a class="el" href="classQXmppTransferJob.html#a22d997eaa5f3f906ef4d9e311a0e3939">QXmppTransferJob::abort()</a> method. </p> + +</div> +</div> +<a class="anchor" id="a3126852f4be7c0d76d34d144e9379688"></a><!-- doxytag: member="QXmppTransferManager::finished" ref="a3126852f4be7c0d76d34d144e9379688" args="(QXmppTransferJob *job)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppTransferManager::finished </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQXmppTransferJob.html">QXmppTransferJob</a> * </td> + <td class="paramname"> <em>job</em></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted whenever a transfer job is finished.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQXmppTransferJob.html#a602987d2e805440c93ef5b625a422856">QXmppTransferJob::finished()</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="aab49bb20e1f0ab52a214d41f127ef19e"></a><!-- doxytag: member="QXmppTransferManager::proxy" ref="aab49bb20e1f0ab52a214d41f127ef19e" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppTransferManager::proxy </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Return the JID of the bytestream proxy to use for outgoing transfers. </p> + +</div> +</div> +<a class="anchor" id="ab905005b46b50707ef476bb8ecca5dfe"></a><!-- doxytag: member="QXmppTransferManager::proxyOnly" ref="ab905005b46b50707ef476bb8ecca5dfe" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppTransferManager::proxyOnly </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Return whether the proxy will systematically be used for outgoing SOCKS5 bytestream transfers. </p> + +</div> +</div> +<a class="anchor" id="a9e08182cdd6f2df3c2d3c19bb9660d24"></a><!-- doxytag: member="QXmppTransferManager::sendFile" ref="a9e08182cdd6f2df3c2d3c19bb9660d24" args="(const QString &jid, QIODevice *device, const QXmppTransferFileInfo &fileInfo, const QString &sid=QString())" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppTransferJob.html">QXmppTransferJob</a> * QXmppTransferManager::sendFile </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>jid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QIODevice * </td> + <td class="paramname"> <em>device</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QXmppTransferFileInfo & </td> + <td class="paramname"> <em>fileInfo</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>sid</em> = <code>QString()</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Send file to a remote party.</p> +<p>The remote party will be given the choice to accept or refuse the transfer. </p> + +</div> +</div> +<a class="anchor" id="adce4271c634320724d044c0678b5dca7"></a><!-- doxytag: member="QXmppTransferManager::sendFile" ref="adce4271c634320724d044c0678b5dca7" args="(const QString &jid, const QString &fileName, const QString &sid=QString())" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppTransferJob.html">QXmppTransferJob</a> * QXmppTransferManager::sendFile </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>jid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>fileName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>sid</em> = <code>QString()</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Send file to a remote party.</p> +<p>The remote party will be given the choice to accept or refuse the transfer. </p> + +</div> +</div> +<a class="anchor" id="ad7d0f0496c85b85b448010d8a3c86d23"></a><!-- doxytag: member="QXmppTransferManager::setProxy" ref="ad7d0f0496c85b85b448010d8a3c86d23" args="(const QString &proxyJid)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppTransferManager::setProxy </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>proxyJid</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Set the JID of the SOCKS5 bytestream proxy to use for outgoing transfers.</p> +<p>If you set a proxy, when you send a file the proxy will be offered to the recipient in addition to your own IP addresses. </p> + +</div> +</div> +<a class="anchor" id="a46b2fc83d7773ae755e04a775694b5b8"></a><!-- doxytag: member="QXmppTransferManager::setProxyOnly" ref="a46b2fc83d7773ae755e04a775694b5b8" args="(bool proxyOnly)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppTransferManager::setProxyOnly </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>proxyOnly</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Set whether the proxy should systematically be used for outgoing SOCKS5 bytestream transfers.</p> +<dl class="note"><dt><b>Note:</b></dt><dd>If you set this to true and do not provide a proxy using <a class="el" href="classQXmppTransferManager.html#ad7d0f0496c85b85b448010d8a3c86d23">setProxy()</a>, your outgoing transfers will fail! </dd></dl> + +</div> +</div> +<a class="anchor" id="a1a6894de4393135f7f80488f180a6ea2"></a><!-- doxytag: member="QXmppTransferManager::setSupportedMethods" ref="a1a6894de4393135f7f80488f180a6ea2" args="(QXmppTransferJob::Methods methods)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppTransferManager::setSupportedMethods </td> + <td>(</td> + <td class="paramtype">QXmppTransferJob::Methods </td> + <td class="paramname"> <em>methods</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Set the supported stream methods. This allows you to selectively enable or disable stream methods (In-Band or SOCKS5 bytestreams).</p> +<p>The methods argument is a combination of zero or more <a class="el" href="classQXmppTransferJob.html#a962582d3049909305277e54e2095c71b" title="This enum is used to describe a transfer method.">QXmppTransferJob::Method</a>. </p> + +</div> +</div> +<a class="anchor" id="a0247768bf90d68e47fe18a75a5659f5c"></a><!-- doxytag: member="QXmppTransferManager::supportedMethods" ref="a0247768bf90d68e47fe18a75a5659f5c" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QXmppTransferJob::Methods QXmppTransferManager::supportedMethods </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Return the supported stream methods.</p> +<p>The methods are a combination of zero or more <a class="el" href="classQXmppTransferJob.html#a962582d3049909305277e54e2095c71b" title="This enum is used to describe a transfer method.">QXmppTransferJob::Method</a>. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="QXmppTransferManager_8h_source.html">QXmppTransferManager.h</a></li> +<li>QXmppTransferManager.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> |