Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-release > by-pkgid > ea24284f03fd4a8a4b64047514d93f64 > files > 195

lib64kdegames1-devel-3.5.9-2mdv2008.1.x86_64.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!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" lang="en_US" xml:lang="en_US">

<head>
  <title>libkdegames: KMessageDirect Class Reference (libkdegames)</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  <meta http-equiv="Content-Style-Type" content="text/css" />

  <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org"  r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org"  r (n 0 s 0 v 0 l 0))' />

  <meta name="trademark" content="KDE e.V." />
  <meta name="description" content="K Desktop Environment Homepage, KDE.org" />
  <meta name="MSSmartTagsPreventParsing" content="true" />
  <meta name="robots" content="all" />

  <link rel="shortcut icon" href="../../favicon.ico" />

<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />



</head>

<body>

<div id="nav_header_top" align="right">
  <a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>

  <a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
  <span class="doNotDisplay">::</span>

  <div id="nav_header_title" align="left">KDE API Reference</div>


</div>

<div id="nav_header_bottom" align="right">
  <span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
  <div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
 / <a href=".">libkdegames</a>
  </div>
</div>


<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
      <td valign="top" class="menuheader" height="0"></td>

  <td id="contentcolumn" valign="top" rowspan="2" >
    <div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
    <a name="content"></a>


<!-- Generated by Doxygen 1.5.5 -->
<div class="contents">
<h1>KMessageDirect Class Reference</h1><!-- doxytag: class="KMessageDirect" --><!-- doxytag: inherits="KMessageIO" --><code>#include &lt;<a class="el" href="kmessageio_8h-source.html">kmessageio.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for KMessageDirect:</div>
<div class="dynsection">

<p><center><img src="classKMessageDirect.png" usemap="#KMessageDirect_map" border="0" alt=""></center>
<map name="KMessageDirect_map">
<area href="classKMessageIO.html" alt="KMessageIO" shape="rect" coords="0,0,105,24">
</map>
</div>

<p>
<a href="classKMessageDirect-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
This class implements the message communication using function calls directly. 
<p>
It can only be used when both sides of the message pipe are within the same process. The communication is very fast.<p>
To establish a communication, you have to create two instances of <a class="el" href="classKMessageDirect.html" title="This class implements the message communication using function calls directly.">KMessageDirect</a>, the first one with no parameters in the constructor, the second one with the first as parameter:<p>
/code <a class="el" href="classKMessageDirect.html" title="This class implements the message communication using function calls directly.">KMessageDirect</a> *peer1, *peer2; peer1 = new <a class="el" href="classKMessageDirect.html" title="This class implements the message communication using function calls directly.">KMessageDirect</a> (); // unconnected peer2 = new <a class="el" href="classKMessageDirect.html" title="This class implements the message communication using function calls directly.">KMessageDirect</a> (peer1); // connect with peer1 /endcode<p>
The connection is only closed when one of the instances is deleted. 
<p>Definition at line <a class="el" href="kmessageio_8h-source.html#l00295">295</a> of file <a class="el" href="kmessageio_8h-source.html">kmessageio.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKMessageDirect.html#26b8990db45f3084e9267623f1aa25c7">KMessageDirect</a> (<a class="el" href="classKMessageDirect.html">KMessageDirect</a> *partner=0, QObject *parent=0, const char *name=0)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKMessageDirect.html#2a7d37f0e955dd40ef35dcb2e13cbff4">~KMessageDirect</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKMessageDirect.html#e8517eccf407859f7de67e4f77baf7a9">rtti</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKMessageDirect.html#fd06fa78bd38c4cb46d05b5138678db2">isNetwork</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKMessageDirect.html#e1a47b43f8cda3f8363491a795c6197b">isConnected</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKMessageDirect.html#ac1022521f741c07ec93db28c5cdd09b">send</a> (const QByteArray &amp;msg)</td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e567970116c0d990a2a6ee19b195a6f"></a><!-- doxytag: member="KMessageDirect::mPartner" ref="3e567970116c0d990a2a6ee19b195a6f" args="" -->
<a class="el" href="classKMessageDirect.html">KMessageDirect</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>mPartner</b></td></tr>

</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="26b8990db45f3084e9267623f1aa25c7"></a><!-- doxytag: member="KMessageDirect::KMessageDirect" ref="26b8990db45f3084e9267623f1aa25c7" args="(KMessageDirect *partner=0, QObject *parent=0, const char *name=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KMessageDirect::KMessageDirect           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classKMessageDirect.html">KMessageDirect</a> *&nbsp;</td>
          <td class="paramname"> <em>partner</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">QObject *&nbsp;</td>
          <td class="paramname"> <em>parent</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Creates an object and connects it to the object given in the first parameter. 
<p>
Use 0 as first parameter to create an unconnected object, that is later connected.<p>
If that object is already connected, the object remains unconnected. 
<p>Definition at line <a class="el" href="kmessageio_8cpp-source.html#l00180">180</a> of file <a class="el" href="kmessageio_8cpp-source.html">kmessageio.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="2a7d37f0e955dd40ef35dcb2e13cbff4"></a><!-- doxytag: member="KMessageDirect::~KMessageDirect" ref="2a7d37f0e955dd40ef35dcb2e13cbff4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KMessageDirect::~KMessageDirect           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destructor, closes the connection. 
<p>

<p>Definition at line <a class="el" href="kmessageio_8cpp-source.html#l00202">202</a> of file <a class="el" href="kmessageio_8cpp-source.html">kmessageio.cpp</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e8517eccf407859f7de67e4f77baf7a9"></a><!-- doxytag: member="KMessageDirect::rtti" ref="e8517eccf407859f7de67e4f77baf7a9" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int KMessageDirect::rtti           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The runtime idendifcation. 
<p>

<p>Reimplemented from <a class="el" href="classKMessageIO.html#389aadce959970213823a2728d00c255">KMessageIO</a>.</p>

<p>Definition at line <a class="el" href="kmessageio_8h-source.html#l00318">318</a> of file <a class="el" href="kmessageio_8h-source.html">kmessageio.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="fd06fa78bd38c4cb46d05b5138678db2"></a><!-- doxytag: member="KMessageDirect::isNetwork" ref="fd06fa78bd38c4cb46d05b5138678db2" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool KMessageDirect::isNetwork           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>FALSE as this is no network IO. </dd></dl>

<p>Reimplemented from <a class="el" href="classKMessageIO.html#1867d5e42cfce261346c38892008c9cf">KMessageIO</a>.</p>

<p>Definition at line <a class="el" href="kmessageio_8h-source.html#l00324">324</a> of file <a class="el" href="kmessageio_8h-source.html">kmessageio.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="e1a47b43f8cda3f8363491a795c6197b"></a><!-- doxytag: member="KMessageDirect::isConnected" ref="e1a47b43f8cda3f8363491a795c6197b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool KMessageDirect::isConnected           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns true, if the object is connected to another instance. 
<p>
If you use the first constructor, the object is unconnected unless another object is created with this one as parameter.<p>
The connection can only be closed by deleting one of the objects. 
<p>Reimplemented from <a class="el" href="classKMessageIO.html#3f93a66d00d8ca535ee5ab12475e30a2">KMessageIO</a>.</p>

<p>Definition at line <a class="el" href="kmessageio_8cpp-source.html#l00211">211</a> of file <a class="el" href="kmessageio_8cpp-source.html">kmessageio.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="ac1022521f741c07ec93db28c5cdd09b"></a><!-- doxytag: member="KMessageDirect::send" ref="ac1022521f741c07ec93db28c5cdd09b" args="(const QByteArray &amp;msg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KMessageDirect::send           </td>
          <td>(</td>
          <td class="paramtype">const QByteArray &amp;&nbsp;</td>
          <td class="paramname"> <em>msg</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Overwritten slot method from <a class="el" href="classKMessageIO.html" title="This abstract base class represents one end of a message connections between two...">KMessageIO</a>. 
<p>
Note: It is not declared as a slot method, since the slot is already defined in <a class="el" href="classKMessageIO.html" title="This abstract base class represents one end of a message connections between two...">KMessageIO</a> as a virtual method. 
<p>Implements <a class="el" href="classKMessageIO.html#595c09956ca3135e868fa9d47fe22958">KMessageIO</a>.</p>

<p>Definition at line <a class="el" href="kmessageio_8cpp-source.html#l00216">216</a> of file <a class="el" href="kmessageio_8cpp-source.html">kmessageio.cpp</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="kmessageio_8h-source.html">kmessageio.h</a><li><a class="el" href="kmessageio_8cpp-source.html">kmessageio.cpp</a></ul>
</div>
    </div></div>


      </td>
  </tr>
  <tr>
    <td valign="top" id="leftmenu" width="25%">
      <a name="navigation"></a>
      <div class="menu_box"><h2>libkdegames</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
  <option value="classKCanvasRootPixmap.html">kcanvasrootpixmap</option>,  <option value="classKCardDialog.html">kcarddialog</option>,  <option value="classKChat.html">kchat</option>,  <option value="classKChatBase.html">kchatbase</option>,  <option value="classKChatBaseText.html">kchatbasetext</option>,  <option value="classKExtHighscore_1_1Item.html">kexthighscore::item</option>,  <option value="classKExtHighscore_1_1ItemArray.html">kexthighscore::itemarray</option>,  <option value="classKExtHighscore_1_1Manager.html">kexthighscore::manager</option>,  <option value="classKExtHighscore_1_1MultiplayerScores.html">kexthighscore::multiplayerscores</option>,  <option value="classKExtHighscore_1_1Score.html">kexthighscore::score</option>,  <option value="classKGame.html">kgame</option>,  <option value="classKGameChat.html">kgamechat</option>,  <option value="classKGameComputerIO.html">kgamecomputerio</option>,  <option value="classKGameConnectDialog.html">kgameconnectdialog</option>,  <option value="classKGameDialog.html">kgamedialog</option>,  <option value="classKGameDialogChatConfig.html">kgamedialogchatconfig</option>,  <option value="classKGameDialogConfig.html">kgamedialogconfig</option>,  <option value="classKGameErrorDialog.html">kgameerrordialog</option>,  <option value="classKGameErrorMessageDialog.html">kgameerrormessagedialog</option>,  <option value="classKGameIO.html">kgameio</option>,  <option value="classKGameKeyIO.html">kgamekeyio</option>,  <option value="classKGameLCD.html">kgamelcd</option>,  <option value="classKGameLCDClock.html">kgamelcdclock</option>,  <option value="classKGameLCDList.html">kgamelcdlist</option>,  <option value="classKGameMisc.html">kgamemisc</option>,  <option value="classKGameMouseIO.html">kgamemouseio</option>,  <option value="classKGameNetwork.html">kgamenetwork</option>,  <option value="classKGameProcess.html">kgameprocess</option>,  <option value="classKGameProcessIO.html">kgameprocessio</option>,  <option value="classKGameProgress.html">kgameprogress</option>,  <option value="classKGameProperty.html">kgameproperty</option>,  <option value="classKGamePropertyBase.html">kgamepropertybase</option>,  <option value="classKGamePropertyHandler.html">kgamepropertyhandler</option>,  <option value="classKGameSequence.html">kgamesequence</option>,  <option value="classKGrid2D_1_1Generic.html">kgrid2d::generic</option>,  <option value="classKGrid2D_1_1Hexagonal.html">kgrid2d::hexagonal</option>,  <option value="classKGrid2D_1_1HexagonalBase.html">kgrid2d::hexagonalbase</option>,  <option value="classKGrid2D_1_1Square.html">kgrid2d::square</option>,  <option value="classKGrid2D_1_1SquareBase.html">kgrid2d::squarebase</option>,  <option value="classKHighscore.html">khighscore</option>,  <option value="classKMessageClient.html">kmessageclient</option>,  <option value="classKMessageDirect.html">kmessagedirect</option>,  <option value="classKMessageIO.html">kmessageio</option>,  <option value="classKMessageServer.html">kmessageserver</option>,  <option value="classKMessageServerSocket.html">kmessageserversocket</option>,  <option value="classKMessageSocket.html">kmessagesocket</option>,  <option value="classKPlayer.html">kplayer</option>,  <option value="classKScoreDialog.html">kscoredialog</option>,  <option value="classKStdGameAction.html">kstdgameaction</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../libkdegames/html/index.html">libkdegames</a></li>
</ul></div></div>


        </td>
</tr>
</table>

<span class="doNotDisplay">
  <a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
  <a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
  <a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>


<div style="height: 8px"></div>

<div id="footer">
  <div id="footer_left">
    Maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">Allen Winter</a>.
<br/>
    KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
    <a href="http://www.kde.org/contact/impressum.php">Legal</a>
  </div>
  <div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>

<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->

</body>
</html>