Some documentation updates.
[MUtilities.git] / docs / d5 / dfe / class_m_utils_1_1_i_p_c_channel.html
blob3e42b6fbfcdee016e4e2660aa7c1cb7475df7e2d
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.12"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>MuldeR&#39;s Utilities for Qt: MUtils::IPCChannel Class Reference</title>
9 <link href="../../tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="../../jquery.js"></script>
11 <script type="text/javascript" src="../../dynsections.js"></script>
12 <link href="../../search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="../../search/searchdata.js"></script>
14 <script type="text/javascript" src="../../search/search.js"></script>
15 <link href="../../doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21 <tbody>
22 <tr style="height: 56px;">
23 <td id="projectalign" style="padding-left: 0.5em;">
24 <div id="projectname">MuldeR&#39;s Utilities for Qt
25 </div>
26 <div id="projectbrief">MUtilities</div>
27 </td>
28 </tr>
29 </tbody>
30 </table>
31 </div>
32 <!-- end header part -->
33 <!-- Generated by Doxygen 1.8.12 -->
34 <script type="text/javascript">
35 var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
36 </script>
37 <script type="text/javascript" src="../../menudata.js"></script>
38 <script type="text/javascript" src="../../menu.js"></script>
39 <script type="text/javascript">
40 $(function() {
41 initMenu('../../',true,false,'search.php','Search');
42 $(document).ready(function() { init_search(); });
43 });
44 </script>
45 <div id="main-nav"></div>
46 <!-- window showing the filter options -->
47 <div id="MSearchSelectWindow"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 onkeydown="return searchBox.OnSearchSelectKey(event)">
51 </div>
53 <!-- iframe showing the search results (closed by default) -->
54 <div id="MSearchResultsWindow">
55 <iframe src="javascript:void(0)" frameborder="0"
56 name="MSearchResults" id="MSearchResults">
57 </iframe>
58 </div>
60 <div id="nav-path" class="navpath">
61 <ul>
62 <li class="navelem"><b>MUtils</b></li><li class="navelem"><a class="el" href="../../d5/dfe/class_m_utils_1_1_i_p_c_channel.html">IPCChannel</a></li> </ul>
63 </div>
64 </div><!-- top -->
65 <div class="header">
66 <div class="summary">
67 <a href="#pub-types">Public Types</a> &#124;
68 <a href="#pub-methods">Public Member Functions</a> &#124;
69 <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
70 <a href="../../d7/dee/class_m_utils_1_1_i_p_c_channel-members.html">List of all members</a> </div>
71 <div class="headertitle">
72 <div class="title">MUtils::IPCChannel Class Reference</div> </div>
73 </div><!--header-->
74 <div class="contents">
75 <table class="memberdecls">
76 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
77 Public Types</h2></td></tr>
78 <tr class="memitem:a6b5ebdf09045f7c0eaaa35de1a8f7721"><td class="memItemLeft" align="right" valign="top"><a id="a6b5ebdf09045f7c0eaaa35de1a8f7721"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>ipc_result_t</b> { <b>RET_SUCCESS_MASTER</b> = 0,
79 <b>RET_SUCCESS_SLAVE</b> = 1,
80 <b>RET_ALREADY_INITIALIZED</b> = 2,
81 <b>RET_FAILURE</b> = 3
82 }</td></tr>
83 <tr class="separator:a6b5ebdf09045f7c0eaaa35de1a8f7721"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 </table><table class="memberdecls">
85 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
86 Public Member Functions</h2></td></tr>
87 <tr class="memitem:acf11b989b4b6172d2ec074543d7d659a"><td class="memItemLeft" align="right" valign="top"><a id="acf11b989b4b6172d2ec074543d7d659a"></a>
88 &#160;</td><td class="memItemRight" valign="bottom"><b>IPCChannel</b> (const QString &amp;applicationId, const quint32 &amp;versionNo, const QString &amp;channelId)</td></tr>
89 <tr class="separator:acf11b989b4b6172d2ec074543d7d659a"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:a4cf5c3ad5d428ef1381bc2a5baab2a84"><td class="memItemLeft" align="right" valign="top"><a id="a4cf5c3ad5d428ef1381bc2a5baab2a84"></a>
91 int&#160;</td><td class="memItemRight" valign="bottom"><b>initialize</b> (void)</td></tr>
92 <tr class="separator:a4cf5c3ad5d428ef1381bc2a5baab2a84"><td class="memSeparator" colspan="2">&#160;</td></tr>
93 <tr class="memitem:a473c8332a6b5855cf2e09118dfb96bbb"><td class="memItemLeft" align="right" valign="top"><a id="a473c8332a6b5855cf2e09118dfb96bbb"></a>
94 bool&#160;</td><td class="memItemRight" valign="bottom"><b>send</b> (const quint32 &amp;command, const quint32 &amp;flags, const QStringList &amp;params=QStringList())</td></tr>
95 <tr class="separator:a473c8332a6b5855cf2e09118dfb96bbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:aff3e92f3605c9d5fce39bfe13799e977"><td class="memItemLeft" align="right" valign="top"><a id="aff3e92f3605c9d5fce39bfe13799e977"></a>
97 bool&#160;</td><td class="memItemRight" valign="bottom"><b>read</b> (quint32 &amp;command, quint32 &amp;flags, QStringList &amp;params)</td></tr>
98 <tr class="separator:aff3e92f3605c9d5fce39bfe13799e977"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 </table><table class="memberdecls">
100 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
101 Static Public Attributes</h2></td></tr>
102 <tr class="memitem:af51f8961959de48b4263c412b83fe3a9"><td class="memItemLeft" align="right" valign="top"><a id="af51f8961959de48b4263c412b83fe3a9"></a>
103 static const quint32&#160;</td><td class="memItemRight" valign="bottom"><b>MAX_PARAM_LEN</b> = 4096</td></tr>
104 <tr class="separator:af51f8961959de48b4263c412b83fe3a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
105 <tr class="memitem:adc01b22e709447201df7a8074272fa1c"><td class="memItemLeft" align="right" valign="top"><a id="adc01b22e709447201df7a8074272fa1c"></a>
106 static const quint32&#160;</td><td class="memItemRight" valign="bottom"><b>MAX_PARAM_CNT</b> = 4</td></tr>
107 <tr class="separator:adc01b22e709447201df7a8074272fa1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
108 </table>
109 <hr/>The documentation for this class was generated from the following file:<ul>
110 <li>include/MUtils/<a class="el" href="../../d1/d93/_i_p_c_channel_8h_source.html">IPCChannel.h</a></li>
111 </ul>
112 </div><!-- contents -->
113 <!-- start footer part -->
114 <hr class="footer"/><address class="footer"><small>
115 Generated on Mon Dec 19 2016 01:56:27 for MuldeR&#39;s Utilities for Qt by &#160;<a href="http://www.doxygen.org/index.html">
116 <img class="footer" src="../../doxygen.png" alt="doxygen"/>
117 </a> 1.8.12
118 </small></address>
119 </body>
120 </html>