File: a00593.html

package info (click to toggle)
qpid-cpp 0.16-6%2Bdeb7u1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 37,232 kB
  • sloc: cpp: 158,939; python: 8,947; sh: 6,701; ruby: 2,080; makefile: 1,838; cs: 1,774; ansic: 1,771; xml: 281; perl: 15; sed: 10
file content (308 lines) | stat: -rw-r--r-- 14,665 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
<!--
 
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership.  The ASF licenses this file
 to you under the Apache License, Version 2.0 (the
 "License"); you may not use this file except in compliance
 with the License.  You may obtain a copy of the License at
 
   http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing,
 software distributed under the License is distributed on an
 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 
-->

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
    <title>qpid::sys::SystemInfo Namespace Reference</title>
    <link href="doxygen.css" rel="stylesheet" type="text/css">
    <link href="tabs.css" rel="stylesheet" type="text/css">
  </head>
  <body bgcolor="#FFFFFF">
  <table border="0" width="90%" align="center">
    <tr>
      <td align="left">
	<a title="Apache Qpid Project Page" href="http://qpid.apache.org">Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET</a>
      </td>

      <td align="right">	
	<a title="Apache Qpid Documentation" href="http://qpid.apache.org/documentation.html">Apache Qpid Documentation</a>
      </td>
    </tr>
  </table>

<!-- Generated by Doxygen 1.7.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="namespaces.html"><span>Namespace&#160;List</span></a></li>
      <li><a href="namespacemembers.html"><span>Namespace&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="a00574.html">qpid</a>      </li>
      <li class="navelem"><a class="el" href="a00592.html">sys</a>      </li>
      <li class="navelem"><a class="el" href="a00593.html">SystemInfo</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">qpid::sys::SystemInfo Namespace Reference</div>  </div>
</div>
<div class="contents">

<p>Retrieve information about the system we are running on.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00593.html#a03b6b12da64157edc0c015fe9dec605b">concurrency</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Estimate available concurrency, e.g.  <a href="#a03b6b12da64157edc0c015fe9dec605b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00593.html#ad108882944288a154c5a13436a6265fd">getLocalHostname</a> (<a class="el" href="a00002.html">Address</a> &amp;address)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the local host name and set it in the specified.  <a href="#ad108882944288a154c5a13436a6265fd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00593.html#a383307c63cd08ce50f44c96248480a7f">getLocalIpAddresses</a> (<a class="el" href="a00556.html#a273cf69d639a59973b6019625df33e30">uint16_t</a> port, <a class="el" href="a00386.html">std::vector</a>&lt; <a class="el" href="a00002.html">Address</a> &gt; &amp;addrList)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00593.html#a5b9675f1298c3c4c9d68fc9140701ec4">getSystemId</a> (<a class="el" href="a00345.html">std::string</a> &amp;osName, <a class="el" href="a00345.html">std::string</a> &amp;nodeName, <a class="el" href="a00345.html">std::string</a> &amp;release, <a class="el" href="a00345.html">std::string</a> &amp;version, <a class="el" href="a00345.html">std::string</a> &amp;machine)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve system identifiers and versions.  <a href="#a5b9675f1298c3c4c9d68fc9140701ec4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00593.html#a562aa24d65c903d28706d5c8dd6f9528">getProcessId</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the process ID of the current process.  <a href="#a562aa24d65c903d28706d5c8dd6f9528"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00593.html#a1a5351e1016b5f7c32ee0899c2e3b63d">getParentProcessId</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the process ID of the parent of the current process.  <a href="#a1a5351e1016b5f7c32ee0899c2e3b63d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00345.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00593.html#a8978a4606139acf8d153676bb3c4aef9">getProcessName</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the current process (i.e.  <a href="#a8978a4606139acf8d153676bb3c4aef9"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Retrieve information about the system we are running on. </p>
<p>Results may be dependent on OS/hardware. </p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a03b6b12da64157edc0c015fe9dec605b"></a><!-- doxytag: member="qpid::sys::SystemInfo::concurrency" ref="a03b6b12da64157edc0c015fe9dec605b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">long qpid::sys::SystemInfo::concurrency </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Estimate available concurrency, e.g. </p>
<p>number of CPU cores. -1 means estimate not available on this platform. </p>

</div>
</div>
<a class="anchor" id="ad108882944288a154c5a13436a6265fd"></a><!-- doxytag: member="qpid::sys::SystemInfo::getLocalHostname" ref="ad108882944288a154c5a13436a6265fd" args="(Address &amp;address)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool qpid::sys::SystemInfo::getLocalHostname </td>
          <td>(</td>
          <td class="paramtype">Address &amp;&#160;</td>
          <td class="paramname"><em>address</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the local host name and set it in the specified. </p>
<p>Returns false if it can't be obtained and sets errno to any error value. </p>

</div>
</div>
<a class="anchor" id="a383307c63cd08ce50f44c96248480a7f"></a><!-- doxytag: member="qpid::sys::SystemInfo::getLocalIpAddresses" ref="a383307c63cd08ce50f44c96248480a7f" args="(uint16_t port, std::vector&lt; Address &gt; &amp;addrList)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void qpid::sys::SystemInfo::getLocalIpAddresses </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00556.html#a273cf69d639a59973b6019625df33e30">uint16_t</a>&#160;</td>
          <td class="paramname"><em>port</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00386.html">std::vector</a>&lt; Address &gt; &amp;&#160;</td>
          <td class="paramname"><em>addrList</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a1a5351e1016b5f7c32ee0899c2e3b63d"></a><!-- doxytag: member="qpid::sys::SystemInfo::getParentProcessId" ref="a1a5351e1016b5f7c32ee0899c2e3b63d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> qpid::sys::SystemInfo::getParentProcessId </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the process ID of the parent of the current process. </p>

</div>
</div>
<a class="anchor" id="a562aa24d65c903d28706d5c8dd6f9528"></a><!-- doxytag: member="qpid::sys::SystemInfo::getProcessId" ref="a562aa24d65c903d28706d5c8dd6f9528" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> qpid::sys::SystemInfo::getProcessId </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the process ID of the current process. </p>

</div>
</div>
<a class="anchor" id="a8978a4606139acf8d153676bb3c4aef9"></a><!-- doxytag: member="qpid::sys::SystemInfo::getProcessName" ref="a8978a4606139acf8d153676bb3c4aef9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00345.html">std::string</a> qpid::sys::SystemInfo::getProcessName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the name of the current process (i.e. </p>
<p>the name of the executable) </p>

</div>
</div>
<a class="anchor" id="a5b9675f1298c3c4c9d68fc9140701ec4"></a><!-- doxytag: member="qpid::sys::SystemInfo::getSystemId" ref="a5b9675f1298c3c4c9d68fc9140701ec4" args="(std::string &amp;osName, std::string &amp;nodeName, std::string &amp;release, std::string &amp;version, std::string &amp;machine)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void qpid::sys::SystemInfo::getSystemId </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00345.html">std::string</a> &amp;&#160;</td>
          <td class="paramname"><em>osName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00345.html">std::string</a> &amp;&#160;</td>
          <td class="paramname"><em>nodeName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00345.html">std::string</a> &amp;&#160;</td>
          <td class="paramname"><em>release</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00345.html">std::string</a> &amp;&#160;</td>
          <td class="paramname"><em>version</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00345.html">std::string</a> &amp;&#160;</td>
          <td class="paramname"><em>machine</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Retrieve system identifiers and versions. </p>
<p>This is information that can generally be retrieved via POSIX uname().</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">osName</td><td>Receives the OS name; e.g., GNU/Linux or Windows </td></tr>
    <tr><td class="paramname">nodeName</td><td>Receives the nodename. This may or may not match the set hostname from <a class="el" href="a00593.html#ad108882944288a154c5a13436a6265fd" title="Get the local host name and set it in the specified.">getLocalHostname()</a>. </td></tr>
    <tr><td class="paramname">release</td><td>Receives the OS release identifier. </td></tr>
    <tr><td class="paramname">version</td><td>Receives the OS release version (kernel, build, sp, etc.) </td></tr>
    <tr><td class="paramname">machine</td><td>Receives the hardware type. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div>
<!--
 
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership.  The ASF licenses this file
 to you under the Apache License, Version 2.0 (the
 "License"); you may not use this file except in compliance
 with the License.  You may obtain a copy of the License at
 
   http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing,
 software distributed under the License is distributed on an
 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 
-->

<hr size="1">
<address style="text-align: left;"><small>
Qpid C++ API Reference</small></address>

<address style="text-align: right;">
<small>
Generated on Thu May 10 2012 for Qpid C++ Client API by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.5</small>
</address>
</body>
</html>