Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / log / doc / html / boost / log / ipc / object_name.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Class object_name</title>
5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
8 <link rel="up" href="../../../utilities.html#header.boost.log.utility.ipc.object_name_hpp" title="Header &lt;boost/log/utility/ipc/object_name.hpp&gt;">
9 <link rel="prev" href="../save_result.html" title="Function template save_result">
10 <link rel="next" href="reliable_message_queue.html" title="Class reliable_message_queue">
11 </head>
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td></tr></table>
14 <hr>
15 <div class="spirit-nav">
16 <a accesskey="p" href="../save_result.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../utilities.html#header.boost.log.utility.ipc.object_name_hpp"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reliable_message_queue.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
17 </div>
18 <div class="refentry">
19 <a name="boost.log.ipc.object_name"></a><div class="titlepage"></div>
20 <div class="refnamediv">
21 <h2><span class="refentrytitle">Class object_name</span></h2>
22 <p>boost::log::ipc::object_name &#8212; A system object name class. </p>
23 </div>
24 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
25 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../utilities.html#header.boost.log.utility.ipc.object_name_hpp" title="Header &lt;boost/log/utility/ipc/object_name.hpp&gt;">boost/log/utility/ipc/object_name.hpp</a>&gt;
26
27 </span>
28 <span class="keyword">class</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">{</span>
29 <span class="keyword">public</span><span class="special">:</span>
30
31   <span class="comment">// Name scopes. </span>
32   <span class="keyword">enum</span> <a name="boost.log.ipc.object_name.scope"></a>scope <span class="special">{</span> global, user, session, process_group <span class="special">}</span><span class="special">;</span>
33   <span class="comment">// <a class="link" href="object_name.html#boost.log.ipc.object_nameconstruct-copy-destruct">construct/copy/destruct</a></span>
34   <a class="link" href="object_name.html#idm45711343675184-bb"><span class="identifier">object_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
35   <a class="link" href="object_name.html#idm45711343673008-bb"><span class="identifier">object_name</span></a><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
36   <a class="link" href="object_name.html#idm45711343671056-bb"><span class="identifier">object_name</span></a><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
37   <a class="link" href="object_name.html#idm45711343669376-bb"><span class="identifier">object_name</span></a><span class="special">(</span><span class="identifier">scope</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
38   <a class="link" href="object_name.html#idm45711343666416-bb"><span class="identifier">object_name</span></a><span class="special">(</span><span class="identifier">scope</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
39   <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;</span> <a class="link" href="object_name.html#idm45711343663472-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
40   <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;</span> <a class="link" href="object_name.html#idm45711343660944-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
41
42   <span class="comment">// <a class="link" href="object_name.html#idm45711343683552-bb">public member functions</a></span>
43   <span class="keyword">bool</span> <a class="link" href="object_name.html#idm45711343682992-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
44   <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="object_name.html#idm45711343680992-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
45   <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="object_name.html#idm45711343679440-bb"><span class="identifier">c_str</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
46   <span class="keyword">void</span> <a class="link" href="object_name.html#idm45711343677888-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
47
48   <span class="comment">// <a class="link" href="object_name.html#idm45711343658688-bb">public static functions</a></span>
49   <span class="keyword">static</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <a class="link" href="object_name.html#idm45711343658128-bb"><span class="identifier">from_native</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
50   <span class="keyword">static</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <a class="link" href="object_name.html#idm45711343654544-bb"><span class="identifier">from_native</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
51
52   <span class="comment">// <a class="link" href="object_name.html#idm45711343651248-bb">friend functions</a></span>
53   <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="object_name.html#idm45711343650688-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
54   <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="object_name.html#idm45711343647200-bb"><span class="identifier">to_string</span></a><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
55   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="object_name.html#idm45711343644928-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
56   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="object_name.html#idm45711343641440-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
57   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="object_name.html#idm45711343637952-bb"><span class="keyword">operator</span><span class="special">&lt;</span></a><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
58   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="object_name.html#idm45711343634464-bb"><span class="keyword">operator</span><span class="special">&gt;</span></a><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
59   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="object_name.html#idm45711343630976-bb"><span class="keyword">operator</span><span class="special">&lt;=</span></a><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
60   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="object_name.html#idm45711343627488-bb"><span class="keyword">operator</span><span class="special">&gt;=</span></a><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
61   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> TraitsT<span class="special">&gt;</span> 
62     <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">TraitsT</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
63     <a class="link" href="object_name.html#idm45711343623984-bb"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">TraitsT</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
64 <span class="special">}</span><span class="special">;</span></pre></div>
65 <div class="refsect1">
66 <a name="idm45554725826864"></a><h2>Description</h2>
67 <p>In order to identify a system-wide object such as a shared memory segment or a named synchronization primitive the object has to be given a name. The format of the name is specific to the operating system and the <code class="computeroutput"><a class="link" href="object_name.html" title="Class object_name">object_name</a></code> class provides an abstraction for names of objects. It also provides means for scoping, which allows to avoid name clashes between different processes.</p>
68 <p>The object name is a UTF-8 encoded string. The portable object name should consist of the following characters:</p>
69 <pre class="programlisting">
70 <span class="identifier">A</span> <span class="identifier">B</span> <span class="identifier">C</span> <span class="identifier">D</span> <span class="identifier">E</span> <span class="identifier">F</span> <span class="identifier">G</span> <span class="identifier">H</span> <span class="identifier">I</span> <span class="identifier">J</span> <span class="identifier">K</span> <span class="identifier">L</span> <span class="identifier">M</span> <span class="identifier">N</span> <span class="identifier">O</span> <span class="identifier">P</span> <span class="identifier">Q</span> <span class="identifier">R</span> <span class="identifier">S</span> <span class="identifier">T</span> <span class="identifier">U</span> <span class="identifier">V</span> <span class="identifier">W</span> <span class="identifier">X</span> <span class="identifier">Y</span> <span class="identifier">Z</span>
71 <span class="identifier">a</span> <span class="identifier">b</span> <span class="identifier">c</span> <span class="identifier">d</span> <span class="identifier">e</span> <span class="identifier">f</span> <span class="identifier">g</span> <span class="identifier">h</span> <span class="identifier">i</span> <span class="identifier">j</span> <span class="identifier">k</span> <span class="identifier">l</span> <span class="identifier">m</span> <span class="identifier">n</span> <span class="identifier">o</span> <span class="identifier">p</span> <span class="identifier">q</span> <span class="identifier">r</span> <span class="identifier">s</span> <span class="identifier">t</span> <span class="identifier">u</span> <span class="identifier">v</span> <span class="identifier">w</span> <span class="identifier">x</span> <span class="identifier">y</span> <span class="identifier">z</span>
72 <span class="number">0</span> <span class="number">1</span> <span class="number">2</span> <span class="number">3</span> <span class="number">4</span> <span class="number">5</span> <span class="number">6</span> <span class="number">7</span> <span class="number">8</span> <span class="number">9</span> <span class="special">.</span> <span class="identifier">_</span> <span class="special">-</span>
73 </pre>
74 <div class="note"><table border="0" summary="Note">
75 <tr>
76 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
77 <th align="left">Note</th>
78 </tr>
79 <tr><td align="left" valign="top"><p>The character set corresponds to the POSIX Portable Filename Character Set (<a href="http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_278" target="_top">http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_278</a>).</p></td></tr>
80 </table></div>
81 <p>
82 Use of other characters may result in non-portable system-specific behavior.</p>
83 <p>The name can have one of the following scopes:</p>
84 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
85 <li class="listitem"><p><code class="computeroutput">global</code> - objects within this scope are visible to any process on the system. In order to use this scope the process may need to have extended privileges. This scope is not available for Windows Store applications. </p></li>
86 <li class="listitem"><p><code class="computeroutput">user</code> - objects within this scope can be opened by processes running under the same user as the current process. </p></li>
87 <li class="listitem"><p><code class="computeroutput">session</code> - objects within this scope are visible to processes within the session of the current process. The definition of a session may vary between operating systems. On POSIX, a session is typically a group of processes attached to a single virtual terminal device. On Windows a session is started when a user logs into the system. There is also a separate session for Windows services. </p></li>
88 <li class="listitem"><p><code class="computeroutput">process_group</code> - objects within this scope are visible to processes within the process group of the current process. Currently, on Windows all processes running in the current session are considered members of the same process group. This may change in future.</p></li>
89 </ul></div>
90 <p>
91 The scopes are not overlapping. For instance, if an object is created in the global scope, the object cannot be opened with the same name but in user's scope.</p>
92 <p>Note that name scoping is not a security feature. On some systems any process on the system has technical capability to open objects within any scope. The scope is only used to help avoid name clashes between processes using <code class="computeroutput"><a class="link" href="object_name.html" title="Class object_name">object_name</a></code> to identify objects. </p>
93 <div class="refsect2">
94 <a name="idm45554725769600"></a><h3>
95 <a name="boost.log.ipc.object_nameconstruct-copy-destruct"></a><code class="computeroutput">object_name</code> 
96         public
97        construct/copy/destruct</h3>
98 <div class="orderedlist"><ol class="orderedlist" type="1">
99 <li class="listitem">
100 <pre class="literallayout"><a name="idm45711343675184-bb"></a><span class="identifier">object_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
101 <p>Default constructor. The method creates an empty object name.</p>
102 <p>
103 </p>
104 <div class="variablelist"><table border="0" class="variablelist compact">
105 <colgroup>
106 <col align="left" valign="top">
107 <col>
108 </colgroup>
109 <tbody><tr>
110 <td><p><span class="term">Postconditions:</span></p></td>
111 <td><p><code class="computeroutput">empty() == true</code> </p></td>
112 </tr></tbody>
113 </table></div>
114 </li>
115 <li class="listitem">
116 <pre class="literallayout"><a name="idm45711343673008-bb"></a><span class="identifier">object_name</span><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;&amp;</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
117 <p>Move constructor. </p>
118 </li>
119 <li class="listitem">
120 <pre class="literallayout"><a name="idm45711343671056-bb"></a><span class="identifier">object_name</span><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
121 <p>Copy constructor. </p>
122 </li>
123 <li class="listitem">
124 <pre class="literallayout"><a name="idm45711343669376-bb"></a><span class="identifier">object_name</span><span class="special">(</span><span class="identifier">scope</span> ns<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> str<span class="special">)</span><span class="special">;</span></pre>
125 <p>Constructor from the object name 
126 </p>
127 <div class="variablelist"><table border="0" class="variablelist compact">
128 <colgroup>
129 <col align="left" valign="top">
130 <col>
131 </colgroup>
132 <tbody><tr>
133 <td><p><span class="term">Parameters:</span></p></td>
134 <td><div class="variablelist"><table border="0" class="variablelist compact">
135 <colgroup>
136 <col align="left" valign="top">
137 <col>
138 </colgroup>
139 <tbody>
140 <tr>
141 <td><p><span class="term"><code class="computeroutput">ns</code></span></p></td>
142 <td><p>The scope of the object name </p></td>
143 </tr>
144 <tr>
145 <td><p><span class="term"><code class="computeroutput">str</code></span></p></td>
146 <td><p>The object name, must not be NULL. </p></td>
147 </tr>
148 </tbody>
149 </table></div></td>
150 </tr></tbody>
151 </table></div>
152 </li>
153 <li class="listitem">
154 <pre class="literallayout"><a name="idm45711343666416-bb"></a><span class="identifier">object_name</span><span class="special">(</span><span class="identifier">scope</span> ns<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="keyword">const</span> <span class="special">&amp;</span> str<span class="special">)</span><span class="special">;</span></pre>
155 <p>Constructor from the object name 
156 </p>
157 <div class="variablelist"><table border="0" class="variablelist compact">
158 <colgroup>
159 <col align="left" valign="top">
160 <col>
161 </colgroup>
162 <tbody><tr>
163 <td><p><span class="term">Parameters:</span></p></td>
164 <td><div class="variablelist"><table border="0" class="variablelist compact">
165 <colgroup>
166 <col align="left" valign="top">
167 <col>
168 </colgroup>
169 <tbody>
170 <tr>
171 <td><p><span class="term"><code class="computeroutput">ns</code></span></p></td>
172 <td><p>The scope of the object name </p></td>
173 </tr>
174 <tr>
175 <td><p><span class="term"><code class="computeroutput">str</code></span></p></td>
176 <td><p>The object name </p></td>
177 </tr>
178 </tbody>
179 </table></div></td>
180 </tr></tbody>
181 </table></div>
182 </li>
183 <li class="listitem">
184 <pre class="literallayout"><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;</span> <a name="idm45711343663472-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;&amp;</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
185 <p>Move assignment </p>
186 </li>
187 <li class="listitem">
188 <pre class="literallayout"><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;</span> <a name="idm45711343660944-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
189 <p>Copy assignment </p>
190 </li>
191 </ol></div>
192 </div>
193 <div class="refsect2">
194 <a name="idm45554725707728"></a><h3>
195 <a name="idm45711343683552-bb"></a><code class="computeroutput">object_name</code> public member functions</h3>
196 <div class="orderedlist"><ol class="orderedlist" type="1">
197 <li class="listitem">
198 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45711343682992-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
199 <p>Returns <code class="computeroutput">true</code> if the object name is empty </p>
200 </li>
201 <li class="listitem">
202 <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idm45711343680992-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
203 <p>Returns length of the name, in bytes </p>
204 </li>
205 <li class="listitem">
206 <pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idm45711343679440-bb"></a><span class="identifier">c_str</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
207 <p>Returns the name string </p>
208 </li>
209 <li class="listitem">
210 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711343677888-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
211 <p>Swaps the object name with another object name </p>
212 </li>
213 </ol></div>
214 </div>
215 <div class="refsect2">
216 <a name="idm45554725677504"></a><h3>
217 <a name="idm45711343658688-bb"></a><code class="computeroutput">object_name</code> public static functions</h3>
218 <div class="orderedlist"><ol class="orderedlist" type="1">
219 <li class="listitem">
220 <pre class="literallayout"><span class="keyword">static</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <a name="idm45711343658128-bb"></a><span class="identifier">from_native</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> str<span class="special">)</span><span class="special">;</span></pre>
221 <p>Constructor from the native string.</p>
222 <p>
223 </p>
224 <div class="variablelist"><table border="0" class="variablelist compact">
225 <colgroup>
226 <col align="left" valign="top">
227 <col>
228 </colgroup>
229 <tbody><tr>
230 <td><p><span class="term">Parameters:</span></p></td>
231 <td><div class="variablelist"><table border="0" class="variablelist compact">
232 <colgroup>
233 <col align="left" valign="top">
234 <col>
235 </colgroup>
236 <tbody><tr>
237 <td><p><span class="term"><code class="computeroutput">str</code></span></p></td>
238 <td><p>The object name string, must not be <code class="computeroutput">NULL</code>. The string format is specific to the operating system. </p></td>
239 </tr></tbody>
240 </table></div></td>
241 </tr></tbody>
242 </table></div>
243 </li>
244 <li class="listitem">
245 <pre class="literallayout"><span class="keyword">static</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <a name="idm45711343654544-bb"></a><span class="identifier">from_native</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="keyword">const</span> <span class="special">&amp;</span> str<span class="special">)</span><span class="special">;</span></pre>
246 <p>Constructor from the native string.</p>
247 <p>
248 </p>
249 <div class="variablelist"><table border="0" class="variablelist compact">
250 <colgroup>
251 <col align="left" valign="top">
252 <col>
253 </colgroup>
254 <tbody><tr>
255 <td><p><span class="term">Parameters:</span></p></td>
256 <td><div class="variablelist"><table border="0" class="variablelist compact">
257 <colgroup>
258 <col align="left" valign="top">
259 <col>
260 </colgroup>
261 <tbody><tr>
262 <td><p><span class="term"><code class="computeroutput">str</code></span></p></td>
263 <td><p>The object name string. The string format is specific to the operating system. </p></td>
264 </tr></tbody>
265 </table></div></td>
266 </tr></tbody>
267 </table></div>
268 </li>
269 </ol></div>
270 </div>
271 <div class="refsect2">
272 <a name="idm45554725652144"></a><h3>
273 <a name="idm45711343651248-bb"></a><code class="computeroutput">object_name</code> friend functions</h3>
274 <div class="orderedlist"><ol class="orderedlist" type="1">
275 <li class="listitem">
276 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idm45711343650688-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;</span> left<span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="special">&amp;</span> right<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
277 <p>Swaps two object names </p>
278 </li>
279 <li class="listitem">
280 <pre class="literallayout"><span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idm45711343647200-bb"></a><span class="identifier">to_string</span><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> name<span class="special">)</span><span class="special">;</span></pre>
281 <p>Returns string representation of the object name </p>
282 </li>
283 <li class="listitem">
284 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idm45711343644928-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> left<span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> right<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
285 <p>Equality operator </p>
286 </li>
287 <li class="listitem">
288 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idm45711343641440-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> left<span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> right<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
289 <p>Inequality operator </p>
290 </li>
291 <li class="listitem">
292 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idm45711343637952-bb"></a><span class="keyword">operator</span><span class="special">&lt;</span><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> left<span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> right<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
293 <p>Less operator </p>
294 </li>
295 <li class="listitem">
296 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idm45711343634464-bb"></a><span class="keyword">operator</span><span class="special">&gt;</span><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> left<span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> right<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
297 <p>Greater operator </p>
298 </li>
299 <li class="listitem">
300 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idm45711343630976-bb"></a><span class="keyword">operator</span><span class="special">&lt;=</span><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> left<span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> right<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
301 <p>Less or equal operator </p>
302 </li>
303 <li class="listitem">
304 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idm45711343627488-bb"></a><span class="keyword">operator</span><span class="special">&gt;=</span><span class="special">(</span><a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> left<span class="special">,</span> <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> right<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
305 <p>Greater or equal operator </p>
306 </li>
307 <li class="listitem">
308 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> TraitsT<span class="special">&gt;</span> 
309   <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">TraitsT</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
310   <a name="idm45711343623984-bb"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">TraitsT</span> <span class="special">&gt;</span> <span class="special">&amp;</span> strm<span class="special">,</span> 
311              <a class="link" href="object_name.html" title="Class object_name">object_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> name<span class="special">)</span><span class="special">;</span></pre>
312 <p>Stream ouput operator </p>
313 </li>
314 </ol></div>
315 </div>
316 </div>
317 </div>
318 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
319 <td align="left"></td>
320 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
321         Distributed under the Boost Software License, Version 1.0. (See accompanying
322         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>).
323       </p>
324 </div></td>
325 </tr></table>
326 <hr>
327 <div class="spirit-nav">
328 <a accesskey="p" href="../save_result.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../utilities.html#header.boost.log.utility.ipc.object_name_hpp"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reliable_message_queue.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
329 </div>
330 </body>
331 </html>