/usr/share/doc/libbobcat3-dev/man/sharedstream.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 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 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 | <html><head>
<title>FBB::SharedStream</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::SharedStream</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::SharedStream(3bobcat)</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::SharedStream(3bobcat)</h1>
<h2>libbobcat-dev_3.19.01-x.tar.gz I/O on shared memory</h2>
<h2>2005-2013</h2>
<p>
<h2>NAME</h2>FBB::SharedStream - I/O operations on shared memory
<p>
<h2>SYNOPSIS</h2>
<strong>#include <bobcat/sharedstream></strong><br>
Linking option: <em>-lpthread -lbobcat</em>
<p>
<h2>DESCRIPTION</h2>
<p>
This class combines the features of the <strong>std::istream</strong> and
<strong>std::ostream</strong> classes, operating on shared memory. As with <em>std::fstream</em>
objects, a <em>seekp</em> or <em>seekg</em> member call is required to switch from
writing to reading or v.v.
<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>
<strong>FBB::SharedStreambuf</strong> (private inheritance),<br>
<strong>std::istream</strong>,<br>
<strong>std::ostream</strong>,<br>
<strong>FBB::SharedEnum__</strong> (cf. <strong>sharedmemory</strong>(3bobcat) for a description of
this last base class).
<p>
<h2>CONSTRUCTORS</h2>
<ul>
<li> <strong>SharedStream()</strong>:<br>
The default constructor defines a stub a <strong>SharedStream</strong> object that
cannot immediately be used to access shared memory. To use it, its
member <em>open</em> must first be called.
<p>
<li> <strong>SharedStream(size_t maxSize, SizeUnit sizeUnit,
std::ios::openmode openMode = std::ios::in | std::ios::out,
size_t access = 0600)</strong>:<br>
This constructor creates a stream inheriting the facilities of an
<em>std::istream</em> and <em>std::ostream</em> that interfaces to a shared
memory segment having a capacity of at least <em>maxSize * sizeUnit</em>
bytes. By default, the shared memory segment is opened for reading and
writing. Different from the open modes used for file streams, creating
a shared memory stream with open modes <em>ios::in | ios::out</em> is
OK. In this case the shared memory segment is created and once
information has been written to the shared memory it can also be read
again. The shared memory's access rights are defined by the <em>access</em>
parameter, using the well-known (<strong>chmod</strong>(1)) way to define the
access rights for the owner, the group and others, using octal
digits. If construction succeeds the shared memory is ready for
use. If construction fails, an <em>FBB::Exception</em> is thrown.
<p>
<li> <strong>SharedStream(int id, std::ios::openmode openMode = std::ios::in |
std::ios::out)</strong>:<br>
This constructor creates a stream inheriting the facilities of an
<em>std::istream</em> and <em>std::ostream</em> that connects to a shared memory
segment having ID <em>id</em>. If construction succeeds the shared memory
is ready for use. If construction fails (e.g., no shared memory
segment having ID <em>id</em> exists), an <em>FBB::Exception</em> is
thrown. Specifying the <em>ios::trunc</em> flag immediately clears the
contents of the shared memory.
</ul>
Copy and move constructors are not available.
<p>
<h2>OVERLOADED OPERATORS</h2>
<p>
The overloaded move and copy assignment operators are not available.
<p>
<h2>MEMBER FUNCTIONS</h2>
<p>
All members of <em>std::istream</em> and <em>std::ostream</em> and the <em>enum</em>
values <em>kB, MB</em>, and <em>GB</em>, defined by <em>FBB::SharedEnum__</em> are available.
<p>
<ul>
<li> <strong>void clear()</strong>:<br>
This member clears the error states of the <em>std::istream</em>
and <em>std::ostream</em> base class objects.
<p>
<li> <strong>int id() const</strong>:<br>
The ID of the shared memory segment is returned.
<p>
<li> <strong>void kill()</strong>:<br>
Without locking the shared memory first, all shared memory is returned
to the operating system. The <strong>FBB::SharedStream</strong> object is unusable
after returning from <em>kill</em>. Other processes that were using the
shared memory can continue to do so.
<p>
<li> <strong>void remove()</strong>:<br>
The shared memory is first locked. Next, all shared memory is returned
to the operating system. The <strong>FBB::SharedStream</strong> object is unusable
after returning from <em>remove</em>. Other processes that were using the
shared memory can continue to do so.
<p>
<li> <strong>void memInfo(std::ostream &out, char const *end = "\n")</strong>:<br>
Information about the <em>SharedMemory</em> object is inserted into the
provide <em>ostream</em> object. The IDs of the shared segments, their
sizes, the maximum number of shared memory segments, the number of
bytes that can be read from the shared memory, and its actual storage
capacity, etc., are displayed. Following the information about the
shaed memory, <em>end</em> is inserted into <em>out</em>.
<p>
<li> <strong>void open(size_t maxSize, SizeUnit sizeUnit,
std::ios::openmode openMode = std::ios::in | std::ios::out,
size_t access = 0600)</strong>:<br>
This member creates a shared memory segment having a capacity of at
least <em>maxSize * sizeUnit</em> bytes, and connects the shared memory
segment to the <strong>FBB::SharedStream</strong>. A matching <em>close</em> member does
not exist and is not required. By default, the shared memory segment
is opened for reading and writing. Different from the open modes used
for file streams, creating a shared memory stream with open modes
<em>ios::in | ios::out</em> is OK. In this case the shared memory segment
is created and once information has been written to the shared memory
it can also be read again. The shared memory's access rights are
defined by the <em>access</em> parameter, using the well-known
(<strong>chmod</strong>(1)) way to define the access rights for the owner, the
group and others, using octal digits. If opening succeeds the shared
memory is ready for use. If opening fails, an <em>FBB::Exception</em> is
thrown.
<p>
<li> <strong>void open(int id, std::ios::openmode openMode = std::ios::in |
std::ios::out)</strong>:<br>
This member connects the <strong>FBB::SharedStream</strong> object to a shared
memory segment having ID <em>id</em>. A matching <em>close</em> member does
not exist and is not required. If opening succeeds the shared
memory is ready for use. If opening fails (e.g., no shared memory
segment having ID <em>id</em> exists), an <em>FBB::Exception</em> is
thrown. Specifying the <em>ios::trunc</em> flag immediately clears the
contents of the shared memory.
</ul>
<p>
<h2>EXAMPLE</h2>
<p>
<pre>
#include <iostream>
#include <string>
#include <ostream>
#include <istream>
#include <bobcat/exception>
#include <bobcat/sharedstream>
using namespace std;
using namespace FBB;
int main()
{
SharedStream shared;
int id = -1;
while (true)
{
cout <<
"\n"
" K kill (no lock) existing shared segment\n"
" R remove existing shared segment\n"
" S show stats of current shared segment\n"
" L <id> Load segment <id>\n"
" c create new shared memory (sets id)\n"
" l lock segment id until key pressed\n"
" p <x> c put char c at offset x\n"
" q quit\n"
" r <x> <n> read n chars from offset x\n"
" w <x> args write all args at offset x\n"
"? ";
char ch;
cin >> ch;
ios::off_type offset;
cout << "Requested: " << ch << '\n';
shared.clear();
switch (ch)
{
case 'c':
{
shared.open(1, SharedStream::kB);
id = shared.id();
cout << "id = " << id << '\n';
shared.memInfo(cout);
cout << '\n';
}
break;
case 'K': // delete segment
case 'R': // delete segment
{
if (id == -1)
{
cout << "No segment loaded\n";
continue;
}
cout << "Removing segment id = " << id << '\n';
if (ch == 'R')
shared.remove();
else
shared.kill();
id = -1;
}
break;
case 'L':
cin >> id;
cout << "Loading segment " << id << '\n';
shared.open(id);
shared.memInfo(cout);
cout << '\n';
break;
case 'S':
if (id == -1)
{
cout << "No segment loaded\n";
continue;
}
shared.memInfo(cout);
cout << '\n';
break;
case 'p': // put a char behind the last written
{
if (id == -1)
{
cout << "No segment loaded\n";
continue;
}
cin >> offset >> ch;
if (!cin)
throw Exception() << "cmd specification error";
shared.seekp(offset);
cout << "Segment id = " << id << " at write offset " <<
shared.tellp() << '\n';
shared.put(ch);
}
break;
case 'r': // put a char behind the last written
{
if (id == -1)
{
cout << "No segment loaded\n";
continue;
}
int n;
cin >> offset >> n;
if (!cin)
throw Exception() << "cmd specification error";
char buf[n];
shared.seekg(offset);
cout << "Segment id = " << id << " at offset " <<
shared.tellg() << ", to read " << n << " bytes\n";
n = shared.read(buf, n).gcount();
if (n < 0)
cout << "No data at " << offset << '\n';
else
{
cout << "Retrieved " << n << " bytes, containing `";
cout.write(buf, n);
cout << "'\n";
for (auto ch: buf)
cout << static_cast<int>(ch) << ' ';
cout << '\n';
}
}
break;
case 'w': // write chars at offset
{
if (id == -1)
{
cout << "No segment loaded\n";
continue;
}
string line;
cin >> offset;
getline(cin, line);
if (!cin)
throw Exception() << "cmd specification error";
streampos pos = shared.seekp(offset).tellp();
cout << "Segment id = " << id << " at offset " <<
pos << ", to write " << line.length() << " bytes\n";
shared.write(line.data(), line.length());
if (!shared)
cout << "No room left to write any bytes\n";
else
cout << "Wrote " << (shared.tellp() - pos) << " bytes\n";
}
break;
case 'q':
return 0;
default:
cout << "request not implemented: " << ch << '\n';
break;
}
}
}
</pre>
<p>
<h2>FILES</h2>
<em>bobcat/sharedstream</em> - defines the class interface
<p>
<h2>SEE ALSO</h2>
<strong>bobcat</strong>(7), <strong>chmod</strong>(1),
<strong>isharedstream</strong>(3bobcat),
<strong>osharedstream</strong>(3bobcat),
<strong>sharedblock</strong>(3bobcat),
<strong>sharedmemory</strong>(3bobcat)
<strong>sharedmutex</strong>(3bobcat),
<strong>sharedpos</strong>(3bobcat),
<strong>sharedsegment</strong>(3bobcat),
<strong>sharedstreambuf</strong>(3bobcat)
<p>
<h2>BUGS</h2>
Note that by default exceptions thrown from within a <strong>std::stream</strong>
object are caught by the stream object, setting its <em>ios::failbit</em> flag. To
allow exceptions to leave a stream object, its <em>exceptions</em> member can be
called, e.g., using:
<pre>
myStream.exceptions(ios::failbit | ios::badbit | ios::eofbit);
</pre>
<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>
|