• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>Class permissions</title>
6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9<link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.permissions_hpp" title="Header &lt;boost/interprocess/permissions.hpp&gt;">
10<link rel="prev" href="operator_idm45304011279584.html" title="Function template operator&gt;&gt;">
11<link rel="next" href="segment_manager.html" title="Class template segment_manager">
12</head>
13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14<table cellpadding="2" width="100%"><tr>
15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
16<td align="center"><a href="../../../../index.html">Home</a></td>
17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20<td align="center"><a href="../../../../more/index.htm">More</a></td>
21</tr></table>
22<hr>
23<div class="spirit-nav">
24<a accesskey="p" href="operator_idm45304011279584.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.permissions_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="segment_manager.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.interprocess.permissions"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Class permissions</span></h2>
30<p>boost::interprocess::permissions</p>
31</div>
32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
33<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="../../interprocess/indexes_reference.html#header.boost.interprocess.permissions_hpp" title="Header &lt;boost/interprocess/permissions.hpp&gt;">boost/interprocess/permissions.hpp</a>&gt;
34
35</span>
36<span class="keyword">class</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">{</span>
37<span class="keyword">public</span><span class="special">:</span>
38  <span class="comment">// <a class="link" href="permissions.html#boost.interprocess.permissionsconstruct-copy-destruct">construct/copy/destruct</a></span>
39  <a class="link" href="permissions.html#idm45304011230224-bb"><span class="identifier">permissions</span></a><span class="special">(</span><span class="identifier">os_permissions_type</span><span class="special">)</span><span class="special">;</span>
40  <a class="link" href="permissions.html#idm45304011228768-bb"><span class="identifier">permissions</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
41
42  <span class="comment">// <a class="link" href="permissions.html#idm45304011237184-bb">public member functions</a></span>
43  <span class="keyword">void</span> <a class="link" href="permissions.html#idm45304011236624-bb"><span class="identifier">set_default</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
44  <span class="keyword">void</span> <a class="link" href="permissions.html#idm45304011235280-bb"><span class="identifier">set_unrestricted</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
45  <span class="keyword">void</span> <a class="link" href="permissions.html#idm45304011233952-bb"><span class="identifier">set_permissions</span></a><span class="special">(</span><span class="identifier">os_permissions_type</span><span class="special">)</span><span class="special">;</span>
46  <span class="identifier">os_permissions_type</span> <a class="link" href="permissions.html#idm45304011231952-bb"><span class="identifier">get_permissions</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
47<span class="special">}</span><span class="special">;</span></pre></div>
48<div class="refsect1">
49<a name="id-1.3.19.17.3.45.4.4"></a><h2>Description</h2>
50<p>The permissions class represents permissions to be set to shared memory or files, that can be constructed form usual permission representations: a SECURITY_ATTRIBUTES pointer in windows or ORed rwx chmod integer in UNIX. </p>
51<div class="refsect2">
52<a name="id-1.3.19.17.3.45.4.4.3"></a><h3>
53<a name="boost.interprocess.permissionsconstruct-copy-destruct"></a><code class="computeroutput">permissions</code>
54        public
55       construct/copy/destruct</h3>
56<div class="orderedlist"><ol class="orderedlist" type="1">
57<li class="listitem">
58<pre class="literallayout"><a name="idm45304011230224-bb"></a><span class="identifier">permissions</span><span class="special">(</span><span class="identifier">os_permissions_type</span> type<span class="special">)</span><span class="special">;</span></pre>
59<p>Constructs a permissions object from a user provided os-dependent permissions. </p>
60</li>
61<li class="listitem">
62<pre class="literallayout"><a name="idm45304011228768-bb"></a><span class="identifier">permissions</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
63<p>Constructs a default permissions object: A null security attributes pointer for windows or 0644 for UNIX. </p>
64</li>
65</ol></div>
66</div>
67<div class="refsect2">
68<a name="id-1.3.19.17.3.45.4.4.4"></a><h3>
69<a name="idm45304011237184-bb"></a><code class="computeroutput">permissions</code> public member functions</h3>
70<div class="orderedlist"><ol class="orderedlist" type="1">
71<li class="listitem">
72<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304011236624-bb"></a><span class="identifier">set_default</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
73<p>Sets permissions to default values: A null security attributes pointer for windows or 0644 for UNIX. </p>
74</li>
75<li class="listitem">
76<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304011235280-bb"></a><span class="identifier">set_unrestricted</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
77<p>Sets permissions to unrestricted access: A null DACL for windows or 0666 for UNIX. </p>
78</li>
79<li class="listitem">
80<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304011233952-bb"></a><span class="identifier">set_permissions</span><span class="special">(</span><span class="identifier">os_permissions_type</span> perm<span class="special">)</span><span class="special">;</span></pre>
81<p>Sets permissions from a user provided os-dependent permissions. </p>
82</li>
83<li class="listitem">
84<pre class="literallayout"><span class="identifier">os_permissions_type</span> <a name="idm45304011231952-bb"></a><span class="identifier">get_permissions</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
85<p>Returns stored os-dependent permissions </p>
86</li>
87</ol></div>
88</div>
89</div>
90</div>
91<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
92<td align="left"></td>
93<td align="right"><div class="copyright-footer">Copyright © 2005-2015 Ion Gaztanaga<p>
94        Distributed under the Boost Software License, Version 1.0. (See accompanying
95        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>)
96      </p>
97</div></td>
98</tr></table>
99<hr>
100<div class="spirit-nav">
101<a accesskey="p" href="operator_idm45304011279584.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.permissions_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="segment_manager.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
102</div>
103</body>
104</html>
105