git.maemo.org Git - tpsession/blob - www/doxygen/classTpSession.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html
   3     PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6   <title>tpsession: TpSession Class Reference</title>
   7   <link href="doxygen.css" rel="stylesheet" type="text/css" />
   8 </head>
   9 <body>
  10 <table border="0" cellpadding="0" cellspacing="0" width="100%">
  11 <tr>
  12 <td width="1">&nbsp;&nbsp;</td>
  13 <td class="postheader" valign="center">
  14 <a href="index.html">
  15 <font color="#004faf">Home</font></a>&nbsp;&middot;
  16 <a href="classes.html">
  17 <font color="#004faf">All Classes</font></a>&nbsp;&middot;
  18 <a href="namespaces.html">
  19 <font color="#004faf">All Namespaces</font></a>&nbsp;&middot;
  20 <a href="modules.html">
  21 <font color="#004faf">Modules</font></a>&nbsp;&middot;
  22 <a href="functions.html">
  23 <font color="#004faf">Functions</font></a>&nbsp;&middot;
  24 <a href="files.html">
  25 <font color="#004faf">Files</font></a>
  26 </td>
  27 </tr>
  28 </table>
  29 </body>
  30 </html>
  31 <!-- Generated by Doxygen 1.5.6 -->
  32 <div class="contents">
  33 <h1>TpSession Class Reference</h1><!-- doxytag: class="TpSession" --><code>#include &lt;<a class="el" href="tpsession_8h-source.html">tpsession.h</a>&gt;</code>
  34 <p>
  35
  36 <p>
  37 <a href="classTpSession-members.html">List of all members.</a><h2>Signals</h2>
  38 <ul>
  39 <li>void <a class="el" href="classTpSession.html#d347e57e90a38ba88de384b0e12d29d9">amReady</a> (<a class="el" href="classTpSession.html">TpSession</a> *)
  40 <li>void <a class="el" href="classTpSession.html#73355b0eefdb9ddf9256cf5564a15384">accountReady</a> (<a class="el" href="classTpSessionAccount.html">TpSessionAccount</a> *)
  41 <li>void <a class="el" href="classTpSession.html#c748175fc27394bebad29dca135ae9b4">channeReady</a> (<a class="el" href="classTpSessionAccount.html">TpSessionAccount</a> *)
  42 <li>void <a class="el" href="classTpSession.html#4140850eed688948df8e86b760ca3ffd">messageReceived</a> (const Tp::ReceivedMessage &amp;, <a class="el" href="classTpSessionAccount.html">TpSessionAccount</a> *)
  43 </ul>
  44 <h2>Public Member Functions</h2>
  45 <ul>
  46 <li><a class="el" href="classTpSession.html#044a254379e9c218db0a94923b6541e2">TpSession</a> (QString cmname=QString(), bool synchronous=FALSE)
  47 <li>void <a class="el" href="classTpSession.html#d4631fd1a7c35a4b964df6e7ba9286b5">sendMessageToAddress</a> (QString connectionMgr, QString address, QString message)
  48 <li><a class="el" href="classTpSessionAccount.html">TpSessionAccount</a> * <a class="el" href="classTpSession.html#eb1e40ae48a4b3e833a62c08a0a843b1">getAccount</a> (const QString cm, const QString protocol=QString())
  49 <li>void <a class="el" href="classTpSession.html#6128c07874af5745ce5313b01c7ab5a8">createChannelListener</a> (const QString &amp;channelType, const Tp::MethodInvocationContextPtr&lt;&gt; &amp;context, const Tp::AccountPtr &amp;account, const Tp::ChannelPtr &amp;channel)
  50 <li>void <a class="el" href="classTpSession.html#4aceacc0eb867cd8624ae647a571fdf6">createObserver</a> ()
  51 </ul>
  52 <h2>Static Public Member Functions</h2>
  53 <ul>
  54 <li>static <a class="el" href="classTpSession.html">TpSession</a> * <a class="el" href="classTpSession.html#a3cb4db71a56f67e75d80a087e8c4805">instance</a> (bool synchronous=TRUE)
  55 </ul>
  56 <h2>Public Attributes</h2>
  57 <ul>
  58 <li>QVector&lt; <a class="el" href="classTpSessionAccount.html">TpSessionAccount</a> * &gt; <a class="el" href="classTpSession.html#f592fe9efb0b7072dc5166a83f11c56c">accounts</a>
  59 </ul>
  60 <hr><a name="_details"></a><h2>Detailed Description</h2>
  61 Top level class, counterpart of Account Manager. <a class="el" href="classTpSession.html">TpSession</a> connects to account manager and requests accounts from it. <a class="el" href="classTpSession.html">TpSession</a> creates <a class="el" href="classTpSessionAccount.html">TpSessionAccount</a> for all accounts . As top level class <a class="el" href="classTpSession.html">TpSession</a> provides simålified interface to send and receive messages via any account. <a class="el" href="classTpSession.html">TpSession</a> provides signal when it has accounts ready. If you require some specific account in constructor, you will receive signal only when this account is ready. If you use constructor without any parameters, you will get one signal for every account. If synchronous is true, constructor is executed as synchronous and it does return after transactions to set up accounts are done. <hr><h2>Constructor &amp; Destructor Documentation</h2>
  62 <a class="anchor" name="044a254379e9c218db0a94923b6541e2"></a><!-- doxytag: member="TpSession::TpSession" ref="044a254379e9c218db0a94923b6541e2" args="(QString cmname=QString(), bool synchronous=FALSE)" -->
  63 <div class="memitem">
  64 <div class="memproto">
  65       <table class="memname">
  66         <tr>
  67           <td class="memname"><a class="el" href="classTpSession.html">TpSession</a>           </td>
  68           <td>(</td>
  69           <td class="paramtype">QString&nbsp;</td>
  70           <td class="paramname"> <em>cmname</em> = <code>QString()</code>, </td>
  71         </tr>
  72         <tr>
  73           <td class="paramkey"></td>
  74           <td></td>
  75           <td class="paramtype">bool&nbsp;</td>
  76           <td class="paramname"> <em>synchronous</em> = <code>FALSE</code></td><td>&nbsp;</td>
  77         </tr>
  78         <tr>
  79           <td></td>
  80           <td>)</td>
  81           <td></td><td></td><td></td>
  82         </tr>
  83       </table>
  84 </div>
  85 <div class="memdoc">
  86
  87 <p>
  88 Construct a new <a class="el" href="classTpSession.html">TpSession</a> object.<p>
  89 <dl compact><dt><b>Parameters:</b></dt><dd>
  90   <table border="0" cellspacing="2" cellpadding="0">
  91     <tr><td valign="top"></td><td valign="top"><em>cmname</em>&nbsp;</td><td>Name of the default connection manager. Can be empty or omnitted, then there is no default connection manager </td></tr>
  92     <tr><td valign="top"></td><td valign="top"><em>synchronous</em>&nbsp;</td><td>if false, asynchronous behavior, function returns immediately and accountReady signals are emitted when accounts are ready if True, synchronous behavior and function returns when accounts are ready </td></tr>
  93   </table>
  94 </dl>
  95
  96 </div>
  97 </div><p>
  98 <hr><h2>Member Function Documentation</h2>
  99 <a class="anchor" name="a3cb4db71a56f67e75d80a087e8c4805"></a><!-- doxytag: member="TpSession::instance" ref="a3cb4db71a56f67e75d80a087e8c4805" args="(bool synchronous=TRUE)" -->
 100 <div class="memitem">
 101 <div class="memproto">
 102       <table class="memname">
 103         <tr>
 104           <td class="memname"><a class="el" href="classTpSession.html">TpSession</a> * instance           </td>
 105           <td>(</td>
 106           <td class="paramtype">bool&nbsp;</td>
 107           <td class="paramname"> <em>synchronous</em> = <code>TRUE</code>          </td>
 108           <td>&nbsp;)&nbsp;</td>
 109           <td><code> [static]</code></td>
 110         </tr>
 111       </table>
 112 </div>
 113 <div class="memdoc">
 114
 115 <p>
 116 Returns pointer to <a class="el" href="classTpSession.html">TpSession</a> singleton. If there is not yet <a class="el" href="classTpSession.html">TpSession</a> Object, creates it with "Ring" connection manager as default<p>
 117 <dl compact><dt><b>Parameters:</b></dt><dd>
 118   <table border="0" cellspacing="2" cellpadding="0">
 119     <tr><td valign="top"></td><td valign="top"><em>synchronous</em>&nbsp;</td><td>if false, asynchronous behavior, function returns immediately and accountReady signals are emitted when accounts are ready if True, synchronous behavior and function returns when accounts are ready </td></tr>
 120   </table>
 121 </dl>
 122
 123 </div>
 124 </div><p>
 125 <a class="anchor" name="d4631fd1a7c35a4b964df6e7ba9286b5"></a><!-- doxytag: member="TpSession::sendMessageToAddress" ref="d4631fd1a7c35a4b964df6e7ba9286b5" args="(QString connectionMgr, QString address, QString message)" -->
 126 <div class="memitem">
 127 <div class="memproto">
 128       <table class="memname">
 129         <tr>
 130           <td class="memname">void sendMessageToAddress           </td>
 131           <td>(</td>
 132           <td class="paramtype">QString&nbsp;</td>
 133           <td class="paramname"> <em>connectionMgr</em>, </td>
 134         </tr>
 135         <tr>
 136           <td class="paramkey"></td>
 137           <td></td>
 138           <td class="paramtype">QString&nbsp;</td>
 139           <td class="paramname"> <em>address</em>, </td>
 140         </tr>
 141         <tr>
 142           <td class="paramkey"></td>
 143           <td></td>
 144           <td class="paramtype">QString&nbsp;</td>
 145           <td class="paramname"> <em>message</em></td><td>&nbsp;</td>
 146         </tr>
 147         <tr>
 148           <td></td>
 149           <td>)</td>
 150           <td></td><td></td><td></td>
 151         </tr>
 152       </table>
 153 </div>
 154 <div class="memdoc">
 155
 156 <p>
 157 Send message using specified connection manager to address<p>
 158 <dl compact><dt><b>Parameters:</b></dt><dd>
 159   <table border="0" cellspacing="2" cellpadding="0">
 160     <tr><td valign="top"></td><td valign="top"><em>connectionMgr</em>&nbsp;</td><td>Name of the connection manager </td></tr>
 161     <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>Valid address for this connection manager type. Asexample telephone number to Ring, GoogleTalk address for Gabble </td></tr>
 162     <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>Message body </td></tr>
 163   </table>
 164 </dl>
 165
 166 </div>
 167 </div><p>
 168 <a class="anchor" name="eb1e40ae48a4b3e833a62c08a0a843b1"></a><!-- doxytag: member="TpSession::getAccount" ref="eb1e40ae48a4b3e833a62c08a0a843b1" args="(const QString cm, const QString protocol=QString())" -->
 169 <div class="memitem">
 170 <div class="memproto">
 171       <table class="memname">
 172         <tr>
 173           <td class="memname"><a class="el" href="classTpSessionAccount.html">TpSessionAccount</a> * getAccount           </td>
 174           <td>(</td>
 175           <td class="paramtype">const QString&nbsp;</td>
 176           <td class="paramname"> <em>cm</em>, </td>
 177         </tr>
 178         <tr>
 179           <td class="paramkey"></td>
 180           <td></td>
 181           <td class="paramtype">const QString&nbsp;</td>
 182           <td class="paramname"> <em>protocol</em> = <code>QString()</code></td><td>&nbsp;</td>
 183         </tr>
 184         <tr>
 185           <td></td>
 186           <td>)</td>
 187           <td></td><td></td><td></td>
 188         </tr>
 189       </table>
 190 </div>
 191 <div class="memdoc">
 192
 193 <p>
 194 Returns pointer to TpSessionAccout object with specified connection manager or protocol, returns NULL if no match found<p>
 195 <dl compact><dt><b>Parameters:</b></dt><dd>
 196   <table border="0" cellspacing="2" cellpadding="0">
 197     <tr><td valign="top"></td><td valign="top"><em>cm</em>&nbsp;</td><td>Name of the connection manager, if left empty matches every entry </td></tr>
 198     <tr><td valign="top"></td><td valign="top"><em>protocol</em>&nbsp;</td><td>Name of the protocol manager, if left empty matches every entry </td></tr>
 199   </table>
 200 </dl>
 201
 202 </div>
 203 </div><p>
 204 <a class="anchor" name="6128c07874af5745ce5313b01c7ab5a8"></a><!-- doxytag: member="TpSession::createChannelListener" ref="6128c07874af5745ce5313b01c7ab5a8" args="(const QString &amp;channelType, const Tp::MethodInvocationContextPtr&lt;&gt; &amp;context, const Tp::AccountPtr &amp;account, const Tp::ChannelPtr &amp;channel)" -->
 205 <div class="memitem">
 206 <div class="memproto">
 207       <table class="memname">
 208         <tr>
 209           <td class="memname">void createChannelListener           </td>
 210           <td>(</td>
 211           <td class="paramtype">const QString &amp;&nbsp;</td>
 212           <td class="paramname"> <em>channelType</em>, </td>
 213         </tr>
 214         <tr>
 215           <td class="paramkey"></td>
 216           <td></td>
 217           <td class="paramtype">const Tp::MethodInvocationContextPtr&lt;&gt; &amp;&nbsp;</td>
 218           <td class="paramname"> <em>context</em>, </td>
 219         </tr>
 220         <tr>
 221           <td class="paramkey"></td>
 222           <td></td>
 223           <td class="paramtype">const Tp::AccountPtr &amp;&nbsp;</td>
 224           <td class="paramname"> <em>account</em>, </td>
 225         </tr>
 226         <tr>
 227           <td class="paramkey"></td>
 228           <td></td>
 229           <td class="paramtype">const Tp::ChannelPtr &amp;&nbsp;</td>
 230           <td class="paramname"> <em>channel</em></td><td>&nbsp;</td>
 231         </tr>
 232         <tr>
 233           <td></td>
 234           <td>)</td>
 235           <td></td><td></td><td></td>
 236         </tr>
 237       </table>
 238 </div>
 239 <div class="memdoc">
 240
 241 <p>
 242
 243 </div>
 244 </div><p>
 245 <a class="anchor" name="4aceacc0eb867cd8624ae647a571fdf6"></a><!-- doxytag: member="TpSession::createObserver" ref="4aceacc0eb867cd8624ae647a571fdf6" args="()" -->
 246 <div class="memitem">
 247 <div class="memproto">
 248       <table class="memname">
 249         <tr>
 250           <td class="memname">void createObserver           </td>
 251           <td>(</td>
 252           <td class="paramname">          </td>
 253           <td>&nbsp;)&nbsp;</td>
 254           <td></td>
 255         </tr>
 256       </table>
 257 </div>
 258 <div class="memdoc">
 259
 260 <p>
 261
 262 </div>
 263 </div><p>
 264 <a class="anchor" name="d347e57e90a38ba88de384b0e12d29d9"></a><!-- doxytag: member="TpSession::amReady" ref="d347e57e90a38ba88de384b0e12d29d9" args="(TpSession *)" -->
 265 <div class="memitem">
 266 <div class="memproto">
 267       <table class="memname">
 268         <tr>
 269           <td class="memname">void amReady           </td>
 270           <td>(</td>
 271           <td class="paramtype"><a class="el" href="classTpSession.html">TpSession</a> *&nbsp;</td>
 272           <td class="paramname"> <em>_t1</em>          </td>
 273           <td>&nbsp;)&nbsp;</td>
 274           <td><code> [signal]</code></td>
 275         </tr>
 276       </table>
 277 </div>
 278 <div class="memdoc">
 279
 280 <p>
 281 Emitted when the account Manager becomes ready<p>
 282 <dl compact><dt><b>Parameters:</b></dt><dd>
 283   <table border="0" cellspacing="2" cellpadding="0">
 284     <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classTpSession.html">TpSession</a></em>&nbsp;</td><td>pointer to <a class="el" href="classTpSession.html">TpSession</a> class </td></tr>
 285   </table>
 286 </dl>
 287
 288 </div>
 289 </div><p>
 290 <a class="anchor" name="73355b0eefdb9ddf9256cf5564a15384"></a><!-- doxytag: member="TpSession::accountReady" ref="73355b0eefdb9ddf9256cf5564a15384" args="(TpSessionAccount *)" -->
 291 <div class="memitem">
 292 <div class="memproto">
 293       <table class="memname">
 294         <tr>
 295           <td class="memname">void accountReady           </td>
 296           <td>(</td>
 297           <td class="paramtype"><a class="el" href="classTpSessionAccount.html">TpSessionAccount</a> *&nbsp;</td>
 298           <td class="paramname"> <em>_t1</em>          </td>
 299           <td>&nbsp;)&nbsp;</td>
 300           <td><code> [signal]</code></td>
 301         </tr>
 302       </table>
 303 </div>
 304 <div class="memdoc">
 305
 306 <p>
 307 Emitted when the account becomes ready<p>
 308 <dl compact><dt><b>Parameters:</b></dt><dd>
 309   <table border="0" cellspacing="2" cellpadding="0">
 310     <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classTpSessionAccount.html">TpSessionAccount</a></em>&nbsp;</td><td>pointer to account become ready </td></tr>
 311   </table>
 312 </dl>
 313
 314 </div>
 315 </div><p>
 316 <a class="anchor" name="c748175fc27394bebad29dca135ae9b4"></a><!-- doxytag: member="TpSession::channeReady" ref="c748175fc27394bebad29dca135ae9b4" args="(TpSessionAccount *)" -->
 317 <div class="memitem">
 318 <div class="memproto">
 319       <table class="memname">
 320         <tr>
 321           <td class="memname">void channeReady           </td>
 322           <td>(</td>
 323           <td class="paramtype"><a class="el" href="classTpSessionAccount.html">TpSessionAccount</a> *&nbsp;</td>
 324           <td class="paramname"> <em>_t1</em>          </td>
 325           <td>&nbsp;)&nbsp;</td>
 326           <td><code> [signal]</code></td>
 327         </tr>
 328       </table>
 329 </div>
 330 <div class="memdoc">
 331
 332 <p>
 333
 334 </div>
 335 </div><p>
 336 <a class="anchor" name="4140850eed688948df8e86b760ca3ffd"></a><!-- doxytag: member="TpSession::messageReceived" ref="4140850eed688948df8e86b760ca3ffd" args="(const Tp::ReceivedMessage &amp;, TpSessionAccount *)" -->
 337 <div class="memitem">
 338 <div class="memproto">
 339       <table class="memname">
 340         <tr>
 341           <td class="memname">void messageReceived           </td>
 342           <td>(</td>
 343           <td class="paramtype">const Tp::ReceivedMessage &amp;&nbsp;</td>
 344           <td class="paramname"> <em>_t1</em>, </td>
 345         </tr>
 346         <tr>
 347           <td class="paramkey"></td>
 348           <td></td>
 349           <td class="paramtype"><a class="el" href="classTpSessionAccount.html">TpSessionAccount</a> *&nbsp;</td>
 350           <td class="paramname"> <em>_t2</em></td><td>&nbsp;</td>
 351         </tr>
 352         <tr>
 353           <td></td>
 354           <td>)</td>
 355           <td></td><td></td><td><code> [signal]</code></td>
 356         </tr>
 357       </table>
 358 </div>
 359 <div class="memdoc">
 360
 361 <p>
 362 Emitted when any of Account Managers recived message<p>
 363 <dl compact><dt><b>Parameters:</b></dt><dd>
 364   <table border="0" cellspacing="2" cellpadding="0">
 365     <tr><td valign="top"></td><td valign="top"><em>Tp::ReceivedMessage</em>&nbsp;</td><td>Message received </td></tr>
 366     <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classTpSessionAccount.html">TpSessionAccount</a></em>&nbsp;</td><td>pointer to account received message </td></tr>
 367   </table>
 368 </dl>
 369
 370 </div>
 371 </div><p>
 372 <hr><h2>Member Data Documentation</h2>
 373 <a class="anchor" name="f592fe9efb0b7072dc5166a83f11c56c"></a><!-- doxytag: member="TpSession::accounts" ref="f592fe9efb0b7072dc5166a83f11c56c" args="" -->
 374 <div class="memitem">
 375 <div class="memproto">
 376       <table class="memname">
 377         <tr>
 378           <td class="memname">QVector&lt;<a class="el" href="classTpSessionAccount.html">TpSessionAccount</a>*&gt; <a class="el" href="classTpSession.html#f592fe9efb0b7072dc5166a83f11c56c">accounts</a>          </td>
 379         </tr>
 380       </table>
 381 </div>
 382 <div class="memdoc">
 383
 384 <p>
 385
 386 </div>
 387 </div><p>
 388 </div>
 389 <p /><address><hr /><div align="center">
 390 <table width="100%" cellspacing="0" border="0"><tr class="address">
 391 <td width="30%">Copyright &copy; 2010 Nokia Corporation</td>
 392 <td width="30%" align="right"><div align="right">TpSession </div></td>
 393 </tr></table></div></address>
 394 </body>
 395 </html>