1 <?xml version="1.0" encoding="iso-8859-1"?>
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">
6 <title>tpsession: TpSessionChannel Class Reference</title>
7 <link href="doxygen.css" rel="stylesheet" type="text/css" />
10 <table border="0" cellpadding="0" cellspacing="0" width="100%">
12 <td width="1"> </td>
13 <td class="postheader" valign="center">
15 <font color="#004faf">Home</font></a> ·
16 <a href="classes.html">
17 <font color="#004faf">All Classes</font></a> ·
18 <a href="namespaces.html">
19 <font color="#004faf">All Namespaces</font></a> ·
20 <a href="modules.html">
21 <font color="#004faf">Modules</font></a> ·
22 <a href="functions.html">
23 <font color="#004faf">Functions</font></a> ·
25 <font color="#004faf">Files</font></a>
31 <!-- Generated by Doxygen 1.5.6 -->
32 <div class="contents">
33 <h1>TpSessionChannel Class Reference</h1><!-- doxytag: class="TpSessionChannel" --><code>#include <<a class="el" href="tpsessionchannel_8h-source.html">tpsessionchannel.h</a>></code>
37 <a href="classTpSessionChannel-members.html">List of all members.</a><h2>Public Slots</h2>
39 <li>void <a class="el" href="classTpSessionChannel.html#4e0fd5e2e07041dcc8597d2bcdbea499">onChannelCreated</a> (Tp::PendingOperation *op)
40 <li>void <a class="el" href="classTpSessionChannel.html#c85bd3ce72c90d371c0310f745fd0a8a">onChannelReady</a> (Tp::PendingOperation *op)
41 <li>void <a class="el" href="classTpSessionChannel.html#7be1a9ff9a419ec6ad9181bc7f5d03a4">onChannelDestroyed</a> (QObject *)
42 <li>void <a class="el" href="classTpSessionChannel.html#b2f00ccd3e99ebbf85a53d304d1c357d">onMessageReceived</a> (const Tp::ReceivedMessage &)
43 <li>void <a class="el" href="classTpSessionChannel.html#c60bf3925f5e9b0d94e2d79e77dfce4c">onMessageSent</a> (const Tp::Message &, Tp::MessageSendingFlags, const QString &)
47 <li>void <a class="el" href="classTpSessionChannel.html#5de64749f3577430d1a71671fd3c6e95">channelReady</a> (<a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> *)
48 <li>void <a class="el" href="classTpSessionChannel.html#ded34126bb6d6ba47c03f1d60eed5a46">channelDestroyed</a> (<a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> *)
49 <li>void <a class="el" href="classTpSessionChannel.html#7f314853fb7788d194f3d787058cdb4e">messageReceived</a> (const Tp::ReceivedMessage &, <a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> *)
50 <li>void <a class="el" href="classTpSessionChannel.html#cc92ecadbc11a5006affb380fdd2baaa">messageSent</a> (const Tp::Message &, Tp::MessageSendingFlags, const QString &, <a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> *)
52 <h2>Public Member Functions</h2>
54 <li><a class="el" href="classTpSessionChannel.html#6c26fbb696360a1680f0b696995e901a">TpSessionChannel</a> (Tp::TextChannelPtr)
55 <li><a class="el" href="classTpSessionChannel.html#5284b7ce529373d971c2c27bd17228d9">TpSessionChannel</a> (Tp::ConnectionPtr conn, const Tp::ContactPtr &contact)
56 <li>void <a class="el" href="classTpSessionChannel.html#e04233efcff669a91705750d4c0aa8cd">sendMessage</a> (QString message)
57 <li>QString <a class="el" href="classTpSessionChannel.html#5a9e90bfd4e34bc406a77c6ea7c1651f">peerId</a> ()
59 <h2>Public Attributes</h2>
61 <li>Tp::ContactPtr <a class="el" href="classTpSessionChannel.html#f7c2c675a255027be0e7586634b8e092">peerContact</a>
62 <li>Tp::TextChannelPtr <a class="el" href="classTpSessionChannel.html#5f12ab30d3a84175b4054772f4225e1f">channel</a>
64 <hr><a name="_details"></a><h2>Detailed Description</h2>
65 When you start chat session or call with your buddy, channel is established with your buddy. <a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> represents this connection. <a class="el" href="classTpSession.html">TpSession</a> account makes automatically channel when you send message to your buddy's address. If you send successive messages to same buddy with <a class="el" href="classTpSessionAccount.html">TpSessionAccount</a>, it automatically reuses existing connection. <hr><h2>Constructor & Destructor Documentation</h2>
66 <a class="anchor" name="6c26fbb696360a1680f0b696995e901a"></a><!-- doxytag: member="TpSessionChannel::TpSessionChannel" ref="6c26fbb696360a1680f0b696995e901a" args="(Tp::TextChannelPtr)" -->
68 <div class="memproto">
69 <table class="memname">
71 <td class="memname"><a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> </td>
73 <td class="paramtype">Tp::TextChannelPtr </td>
74 <td class="paramname"> <em>ch</em> </td>
75 <td> ) </td>
83 Construct a new <a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> object. This constructor is called by <a class="el" href="classTpSessionAccount.html">TpSessionAccount</a> class when new channel is created . It is not inended to be used stand alone This varient with connection only parameter is intented for receiving new connection from your peer<p>
84 <dl compact><dt><b>Parameters:</b></dt><dd>
85 <table border="0" cellspacing="2" cellpadding="0">
86 <tr><td valign="top"></td><td valign="top"><em>conn</em> </td><td>connection where this channel is created </td></tr>
92 <a class="anchor" name="5284b7ce529373d971c2c27bd17228d9"></a><!-- doxytag: member="TpSessionChannel::TpSessionChannel" ref="5284b7ce529373d971c2c27bd17228d9" args="(Tp::ConnectionPtr conn, const Tp::ContactPtr &contact)" -->
94 <div class="memproto">
95 <table class="memname">
97 <td class="memname"><a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> </td>
99 <td class="paramtype">Tp::ConnectionPtr </td>
100 <td class="paramname"> <em>conn</em>, </td>
103 <td class="paramkey"></td>
105 <td class="paramtype">const Tp::ContactPtr & </td>
106 <td class="paramname"> <em>contact</em></td><td> </td>
111 <td></td><td></td><td></td>
118 Construct a new <a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> object. This constructor is called by <a class="el" href="classTpSessionAccount.html">TpSessionAccount</a> class when new channel is created . It is not inended to be used stand alone This varient with connection and contact as parameter is intented for creationg new connection from origginator side to your peer<p>
119 <dl compact><dt><b>Parameters:</b></dt><dd>
120 <table border="0" cellspacing="2" cellpadding="0">
121 <tr><td valign="top"></td><td valign="top"><em>conn</em> </td><td>connection where this channel is created </td></tr>
122 <tr><td valign="top"></td><td valign="top"><em>contact</em> </td><td>Contacto to your peer to establish channel </td></tr>
128 <hr><h2>Member Function Documentation</h2>
129 <a class="anchor" name="e04233efcff669a91705750d4c0aa8cd"></a><!-- doxytag: member="TpSessionChannel::sendMessage" ref="e04233efcff669a91705750d4c0aa8cd" args="(QString message)" -->
130 <div class="memitem">
131 <div class="memproto">
132 <table class="memname">
134 <td class="memname">void sendMessage </td>
136 <td class="paramtype">QString </td>
137 <td class="paramname"> <em>message</em> </td>
138 <td> ) </td>
146 Send message to to ths channel<p>
147 <dl compact><dt><b>Parameters:</b></dt><dd>
148 <table border="0" cellspacing="2" cellpadding="0">
149 <tr><td valign="top"></td><td valign="top"><em>message</em> </td><td>message to send </td></tr>
155 <a class="anchor" name="5a9e90bfd4e34bc406a77c6ea7c1651f"></a><!-- doxytag: member="TpSessionChannel::peerId" ref="5a9e90bfd4e34bc406a77c6ea7c1651f" args="()" -->
156 <div class="memitem">
157 <div class="memproto">
158 <table class="memname">
160 <td class="memname">QString peerId </td>
162 <td class="paramname"> </td>
163 <td> ) </td>
171 Get id ( address of your peer )<p>
172 <dl class="return" compact><dt><b>Returns:</b></dt><dd>your peer id/address ir empty QString </dd></dl>
176 <a class="anchor" name="5de64749f3577430d1a71671fd3c6e95"></a><!-- doxytag: member="TpSessionChannel::channelReady" ref="5de64749f3577430d1a71671fd3c6e95" args="(TpSessionChannel *)" -->
177 <div class="memitem">
178 <div class="memproto">
179 <table class="memname">
181 <td class="memname">void channelReady </td>
183 <td class="paramtype"><a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> * </td>
184 <td class="paramname"> <em>_t1</em> </td>
185 <td> ) </td>
186 <td><code> [signal]</code></td>
193 Emitted when the channel becomes ready<p>
194 <dl compact><dt><b>Parameters:</b></dt><dd>
195 <table border="0" cellspacing="2" cellpadding="0">
196 <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classTpSessionChannel.html">TpSessionChannel</a></em> </td><td>pointer to channel become ready </td></tr>
202 <a class="anchor" name="ded34126bb6d6ba47c03f1d60eed5a46"></a><!-- doxytag: member="TpSessionChannel::channelDestroyed" ref="ded34126bb6d6ba47c03f1d60eed5a46" args="(TpSessionChannel *)" -->
203 <div class="memitem">
204 <div class="memproto">
205 <table class="memname">
207 <td class="memname">void channelDestroyed </td>
209 <td class="paramtype"><a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> * </td>
210 <td class="paramname"> <em>_t1</em> </td>
211 <td> ) </td>
212 <td><code> [signal]</code></td>
219 Emitted when the channel is destroyed<p>
220 <dl compact><dt><b>Parameters:</b></dt><dd>
221 <table border="0" cellspacing="2" cellpadding="0">
222 <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classTpSessionChannel.html">TpSessionChannel</a></em> </td><td>pointer to channel destroyed. The pointer is only for referenc to remove it from some possible places where it could be stored. It is not guaranteed to point any more valid <a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> object </td></tr>
228 <a class="anchor" name="7f314853fb7788d194f3d787058cdb4e"></a><!-- doxytag: member="TpSessionChannel::messageReceived" ref="7f314853fb7788d194f3d787058cdb4e" args="(const Tp::ReceivedMessage &, TpSessionChannel *)" -->
229 <div class="memitem">
230 <div class="memproto">
231 <table class="memname">
233 <td class="memname">void messageReceived </td>
235 <td class="paramtype">const Tp::ReceivedMessage & </td>
236 <td class="paramname"> <em>_t1</em>, </td>
239 <td class="paramkey"></td>
241 <td class="paramtype"><a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> * </td>
242 <td class="paramname"> <em>_t2</em></td><td> </td>
247 <td></td><td></td><td><code> [signal]</code></td>
257 <a class="anchor" name="cc92ecadbc11a5006affb380fdd2baaa"></a><!-- doxytag: member="TpSessionChannel::messageSent" ref="cc92ecadbc11a5006affb380fdd2baaa" args="(const Tp::Message &, Tp::MessageSendingFlags, const QString &, TpSessionChannel *)" -->
258 <div class="memitem">
259 <div class="memproto">
260 <table class="memname">
262 <td class="memname">void messageSent </td>
264 <td class="paramtype">const Tp::Message & </td>
265 <td class="paramname"> <em>_t1</em>, </td>
268 <td class="paramkey"></td>
270 <td class="paramtype">Tp::MessageSendingFlags </td>
271 <td class="paramname"> <em>_t2</em>, </td>
274 <td class="paramkey"></td>
276 <td class="paramtype">const QString & </td>
277 <td class="paramname"> <em>_t3</em>, </td>
280 <td class="paramkey"></td>
282 <td class="paramtype"><a class="el" href="classTpSessionChannel.html">TpSessionChannel</a> * </td>
283 <td class="paramname"> <em>_t4</em></td><td> </td>
288 <td></td><td></td><td><code> [signal]</code></td>
295 <dl compact><dt><b>Parameters:</b></dt><dd>
296 <table border="0" cellspacing="2" cellpadding="0">
297 <tr><td valign="top"></td><td valign="top"><em>Tp::Message</em> </td><td>message sent </td></tr>
303 <a class="anchor" name="4e0fd5e2e07041dcc8597d2bcdbea499"></a><!-- doxytag: member="TpSessionChannel::onChannelCreated" ref="4e0fd5e2e07041dcc8597d2bcdbea499" args="(Tp::PendingOperation *op)" -->
304 <div class="memitem">
305 <div class="memproto">
306 <table class="memname">
308 <td class="memname">void onChannelCreated </td>
310 <td class="paramtype">Tp::PendingOperation * </td>
311 <td class="paramname"> <em>op</em> </td>
312 <td> ) </td>
313 <td><code> [slot]</code></td>
323 <a class="anchor" name="c85bd3ce72c90d371c0310f745fd0a8a"></a><!-- doxytag: member="TpSessionChannel::onChannelReady" ref="c85bd3ce72c90d371c0310f745fd0a8a" args="(Tp::PendingOperation *op)" -->
324 <div class="memitem">
325 <div class="memproto">
326 <table class="memname">
328 <td class="memname">void onChannelReady </td>
330 <td class="paramtype">Tp::PendingOperation * </td>
331 <td class="paramname"> <em>op</em> </td>
332 <td> ) </td>
333 <td><code> [slot]</code></td>
343 <a class="anchor" name="7be1a9ff9a419ec6ad9181bc7f5d03a4"></a><!-- doxytag: member="TpSessionChannel::onChannelDestroyed" ref="7be1a9ff9a419ec6ad9181bc7f5d03a4" args="(QObject *)" -->
344 <div class="memitem">
345 <div class="memproto">
346 <table class="memname">
348 <td class="memname">void onChannelDestroyed </td>
350 <td class="paramtype">QObject * </td>
351 <td class="paramname"> <em>obj</em> </td>
352 <td> ) </td>
353 <td><code> [slot]</code></td>
363 <a class="anchor" name="b2f00ccd3e99ebbf85a53d304d1c357d"></a><!-- doxytag: member="TpSessionChannel::onMessageReceived" ref="b2f00ccd3e99ebbf85a53d304d1c357d" args="(const Tp::ReceivedMessage &)" -->
364 <div class="memitem">
365 <div class="memproto">
366 <table class="memname">
368 <td class="memname">void onMessageReceived </td>
370 <td class="paramtype">const Tp::ReceivedMessage & </td>
371 <td class="paramname"> <em>msg</em> </td>
372 <td> ) </td>
373 <td><code> [slot]</code></td>
383 <a class="anchor" name="c60bf3925f5e9b0d94e2d79e77dfce4c"></a><!-- doxytag: member="TpSessionChannel::onMessageSent" ref="c60bf3925f5e9b0d94e2d79e77dfce4c" args="(const Tp::Message &, Tp::MessageSendingFlags, const QString &)" -->
384 <div class="memitem">
385 <div class="memproto">
386 <table class="memname">
388 <td class="memname">void onMessageSent </td>
390 <td class="paramtype">const Tp::Message & </td>
391 <td class="paramname"> <em>msg</em>, </td>
394 <td class="paramkey"></td>
396 <td class="paramtype">Tp::MessageSendingFlags </td>
397 <td class="paramname"> <em>sflags</em>, </td>
400 <td class="paramkey"></td>
402 <td class="paramtype">const QString & </td>
403 <td class="paramname"> <em>flags</em></td><td> </td>
408 <td></td><td></td><td><code> [slot]</code></td>
418 <hr><h2>Member Data Documentation</h2>
419 <a class="anchor" name="f7c2c675a255027be0e7586634b8e092"></a><!-- doxytag: member="TpSessionChannel::peerContact" ref="f7c2c675a255027be0e7586634b8e092" args="" -->
420 <div class="memitem">
421 <div class="memproto">
422 <table class="memname">
424 <td class="memname">Tp::ContactPtr <a class="el" href="classTpSessionChannel.html#f7c2c675a255027be0e7586634b8e092">peerContact</a> </td>
434 <a class="anchor" name="5f12ab30d3a84175b4054772f4225e1f"></a><!-- doxytag: member="TpSessionChannel::channel" ref="5f12ab30d3a84175b4054772f4225e1f" args="" -->
435 <div class="memitem">
436 <div class="memproto">
437 <table class="memname">
439 <td class="memname">Tp::TextChannelPtr <a class="el" href="classTpSessionChannel.html#5f12ab30d3a84175b4054772f4225e1f">channel</a> </td>
450 <p /><address><hr /><div align="center">
451 <table width="100%" cellspacing="0" border="0"><tr class="address">
452 <td width="30%">Copyright © 2010 Nokia Corporation</td>
453 <td width="30%" align="right"><div align="right">TpSession </div></td>
454 </tr></table></div></address>