/usr/share/doc/libbobcat3-dev/man/sharedmutex.3.html is in libbobcat-dev 3.19.01-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <html><head>
<title>FBB::SharedMutex</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::SharedMutex</h1>
<h2>libbobcat-dev_3.19.01-x.tar.gz</h2>
<h2>2005-2013</h2>
<html><head>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1></h1>
<html><head>
<title>FBB::SharedMutex(3bobcat)</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::SharedMutex(3bobcat)</h1>
<h2>libbobcat-dev_3.19.01-x.tar.gz Shared Memory Mutex</h2>
<h2>2005-2013</h2>
<p>
<h2>NAME</h2>FBB::SharedMutex - Mutex for shared memory
<p>
<h2>SYNOPSIS</h2>
<strong>#include <bobcat/sharedmutex></strong><br>
Linking option: <em>-lpthread, -lbobcat </em>
<p>
<h2>DESCRIPTION</h2>
Shared memory may be used by multiple processes. To synchronize access to
shared memory an <strong>FBB::SharedMutex</strong> may be defined inside a shared memory
segment. An <strong>FBB::SharedMutex</strong> allows clients to lock a shared memory
segment before reading or writing its contents. E.g., the Bobcat class
<em>FBB::SharedSegment</em> defines a <em>SharedMutex</em> in its shared memory segment.
<p>
The <strong>FBB::SharedMutex</strong> class uses the facilities offered by the
<em>PThread</em> library to implement shared memory locking. To force
unlocking a (possibly) locked shared memory segment, its destructor can be
called.
<p>
<h2>NAMESPACE</h2>
<strong>FBB</strong><br>
All constructors, members, operators and manipulators, mentioned in this
man-page, are defined in the namespace <strong>FBB</strong>.
<p>
<h2>INHERITS FROM</h2>
-
<p>
<h2>CONSTRUCTORS</h2>
<ul>
<li> <strong>SharedMutex()</strong>:<br>
The default constructor initializes an <strong>FBB::SharedMutex</strong> object to a
shared memory mutex (using the <em>PTHREAD_PROCESS_SHARED</em>
attribute). As an <strong>FBB::SharedMutex</strong> object will normally be defined
inside a shared memory segment the object's memory is already
available. In this case placement new should be used to call the
constructor. E.g., if a shared memory segment is attached to the
current process at <em>d_shared</em>, and an <strong>FBB::SharedMutex</strong> should be
defined at <em>d_shared</em>'s address, then the <strong>FBB::SharedMutex</strong>
object can be initialized like this:
<pre>
new (d_shared) FBB::SharedMutex;
</pre>
</ul>
The copy and move constructors are not available.
<p>
The class's destructor releasea all of the current process's nested
shared memory segment locks. To destroy an <strong>FBB::SharedMuted</strong> object
that has been constructed using the placement <em>new</em> operator use
<pre>
d_sharedMutex->~SharedMutex();
</pre>
(assuming <em>SharedMutex *d_sharedMutex</em> points to the location where
placement new has previously initialized the <strong>FBB::SharedMutex</strong>
object.)
<p>
<h2>MEMBER FUNCTIONS</h2>
<ul>
<li> <strong>void lock() const</strong>:<br>
When returning from this member, the current process has locked the
shared memory segment.
<p>
<li> <strong>void unlock() const</strong>:<br>
The object's lock of the shared memory segment is released.
</ul>
<p>
<h2>EXAMPLE</h2>
See the <strong>sharedstream</strong>(3bobcat) man page.
<p>
<h2>FILES</h2>
<em>bobcat/sharedmutex</em> - defines the class interface
<p>
<h2>SEE ALSO</h2>
<strong>bobcat</strong>(7)
<strong>isharedstream</strong>(3bobcat),
<strong>osharedstream</strong>(3bobcat),
<strong>sharedblock</strong>(3bobcat),
<strong>sharedmemory</strong>(3bobcat),
<strong>sharedpos</strong>(3bobcat),
<strong>sharedsegment</strong>(3bobcat),
<strong>sharedstream</strong>(3bobcat),
<strong>sharedstreambuf</strong>(3bobcat)
<p>
<h2>BUGS</h2>
None Reported.
<p>
<h2>DISTRIBUTION FILES</h2>
<ul>
<li> <em>bobcat_3.19.01-x.dsc</em>: detached signature;
<li> <em>bobcat_3.19.01-x.tar.gz</em>: source archive;
<li> <em>bobcat_3.19.01-x_i386.changes</em>: change log;
<li> <em>libbobcat1_3.19.01-x_*.deb</em>: debian package holding the
libraries;
<li> <em>libbobcat1-dev_3.19.01-x_*.deb</em>: debian package holding the
libraries, headers and manual pages;
<li> <em>http://sourceforge.net/projects/bobcat</em>: public archive location;
</ul>
<p>
<h2>BOBCAT</h2>
Bobcat is an acronym of `Brokken's Own Base Classes And Templates'.
<p>
<h2>COPYRIGHT</h2>
This is free software, distributed under the terms of the
GNU General Public License (GPL).
<p>
<h2>AUTHOR</h2>
Frank B. Brokken (<strong>f.b.brokken@rug.nl</strong>).
<p>
|