/usr/share/doc/libbobcat3/man/localclientsocket.3.html is in libbobcat-dev 3.23.01-1.
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 | <html><head>
<title>FBB::LocalClientSocket</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::LocalClientSocket</h1>
<h2>libbobcat-dev_3.23.01-x.tar.gz</h2>
<h2>2005-2014</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::LocalClientSocket(3bobcat)</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::LocalClientSocket(3bobcat)</h1>
<h2>libbobcat-dev_3.23.01-x.tar.gz Unix Domain client Socket</h2>
<h2>2005-2014</h2>
<p>
<h2>NAME</h2>FBB::LocalClientSocket - Client Socket connecting to a Server in the Unix Domain
<p>
<h2>SYNOPSIS</h2>
<strong>#include <bobcat/localclientsocket></strong><br>
Linking option: <em>-lbobcat</em>
<p>
<h2>DESCRIPTION</h2>
An <strong>FBB::LocalClientSocket</strong> may be constructed to connect to a server
process in the Unix Domain. The socket made available by the
<strong>FBB:LocalClientSocket</strong> may be used to initialize a <strong>std::istream</strong> and/or
<strong>std::ostream</strong>. The <strong>std::istream</strong> is used to read information from the
server process to which the <strong>FBB::LocalClientSocket</strong> connects, The
<strong>std::ostream</strong> is used to send information to the server process to which
the <strong>FBB::LocalClientSocket</strong> connects. Since a socket may be considered a
<em>file descriptor</em> the avaiable <strong>FBB::IFdStream</strong>, <strong>FBB::IFdStreamBuf</strong>,
<strong>FBB::OFdStream</strong>, and <strong>FBB::OFdStreamBuf</strong> classes may be used profitably
here. Note that having available a socket does not mean that this defines the
communication protocol. It is (still) the responsibility of the programmer to
comply with an existing protocol or to implement a tailor-made protocol. The
latter situation implies that the sequence of input- and output operations is
defined by the programmer.
<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::LocalSocketBase</strong>
<p>
<h2>CONSTRUCTOR</h2>
<ul>
<li> <strong>LocalClientSocket()</strong>:<br>
This constructor merely creates a <strong>FBB::LocalClientSocket</strong>
object. Before it can be used, its <em>open()</em> member must be called.
<li> <strong>LocalClientSocket(std::string const &name)</strong>:<br>
This constructor initializes an <strong>FBB::LocalClientSocket</strong> object,
using the named Unix Domain socket to connect to the server using the named
Unix Domain socket. An <strong>FBB::Exception</strong> is thrown if the socket could not be
constructed. The construction of the socket does not mean that a connection
has actually been established. In order to connect to the server, the member
<strong>connect()</strong> (see below) should be used.
</ul>
The copy constructor is not available.
<p>
<h2>MEMBER FUNCTION</h2>
<ul>
<li> <strong>int connect()</strong>:<br>
This member returns a socket that can be used to communicate with the
server process. An <strong>FBB::Exception</strong> exception is thrown if the connection could
not be established.
<li> <strong>open(std::string const &name)</strong>:<br>
This member function prepares the <strong>FBB::LocalClientSocket</strong> object,
constructed earlier using the default constructor, for use. The named Unix
Domain socket is used to connect to the server using the named Unix Domain
socket. An <strong>FBB::Exception</strong> is thrown if the socket could not be
constructed. The construction of the socket does not mean that a connection
has actually been established. In order to connect to the server, the member
<strong>connect()</strong> should be used.
</ul>
<p>
<h2>EXAMPLE</h2>
See also the <strong>localserversocket</strong>(3bobcat) example.
<pre>
#include <iostream>
#include <bobcat/localclientsocket>
#include <bobcat/ifdstream>
#include <bobcat/ofdstream>
using namespace std;
using namespace FBB;
int main(int argc, char **argv)
try
{
if (argc == 1)
{
cerr << "Provide filename representing the unix domain socket\n";
return 1;
}
LocalClientSocket client(argv[1]);
int fd = client.connect();
string line;
cout << "Connecting to socket " << fd << endl;
IFdStream in(fd); // stream to read from
OFdStream out(fd); // stream to write to
while (true)
{
// Ask for a textline, stop if empty / none
cout << "? ";
if (!getline(cin, line) || line.length() == 0)
return 0;
cout << "Line read: " << line << endl;
// Return the line to the server
out << line.c_str() << endl;
cout << "wrote line\n";
// Wait for a reply from the server
getline(in, line);
cout << "Answer: " << line << endl;
}
return 0;
}
catch (Exception const &err)
{
cerr << err.what() << "\n" <<
"Can't connect to " << argv[1] << ", port " << argv[2] << endl;
return 1;
}
</pre>
<p>
<h2>FILES</h2>
<em>bobcat/localclientsocket</em> - defines the class interface
<p>
<h2>SEE ALSO</h2>
<strong>bobcat</strong>(7), <strong>ifdstream</strong>(3bobcat), <strong>ifdstreambuf</strong>(3bobcat),
<strong>clientsocket</strong>(3bobcat), <strong>localserversocket</strong>(3bobcat),
<strong>localsocketbase</strong>(3bobcat), <strong>ofdstream</strong>(3bobcat), <strong>ofdstream</strong>(3bobcat)
<p>
<h2>BUGS</h2>
None Reported.
<p>
<h2>DISTRIBUTION FILES</h2>
<ul>
<li> <em>bobcat_3.23.01-x.dsc</em>: detached signature;
<li> <em>bobcat_3.23.01-x.tar.gz</em>: source archive;
<li> <em>bobcat_3.23.01-x_i386.changes</em>: change log;
<li> <em>libbobcat1_3.23.01-x_*.deb</em>: debian package holding the
libraries;
<li> <em>libbobcat1-dev_3.23.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>
|