libbobcat-dev 3.23.01-1 / usr / share / doc / libbobcat3 / man / socketbase.3.html

This file is indexed.

/usr/share/doc/libbobcat3/man/socketbase.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
<html><head>
<title>FBB::SocketBase</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::SocketBase</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::SocketBase(3bobcat)</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::SocketBase(3bobcat)</h1>
<h2>libbobcat-dev_3.23.01-x.tar.gz Base class for sockets</h2>
<h2>2005-2014</h2>


<p>
<h2>NAME</h2>FBB::SocketBase - Base class for socket-constructing classes
<p>
<h2>SYNOPSIS</h2>
    <strong>#include &lt;bobcat/socketbase&gt;</strong><br>
    Linking option: <em>-lbobcat</em> 
<p>
<h2>DESCRIPTION</h2>
    This class is a base class for the <strong>FBB::ServerSocket</strong> and
<strong>FBB::ClientSocket</strong> classes. Since it is designed as a base class, all its
constructors are protected.
<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::InetAddress</strong>
<p>
<h2>PROTECTED CONSTRUCTORS</h2>
    <ul>
    <li> <strong>SocketBase(size_t port)</strong>:<br> 
       This constructor creates a <strong>SocketBase</strong> to be used with
        <strong>ServerSocket</strong>-objects, listening on <em>port</em>.  
<p>
This constructor throws an <em>Exception</em> exception if it did not
        properly complete.
<p>
<li> <strong>SocketBase(std::string const &amp;host, uint16_t port)</strong>:<br> 
       This constructor creates a <strong>FBB::SocketBase</strong> to be used with a
        <strong>ClientSocket</strong>-object, connecting to <em>hostname</em>, at port
        `<em>port</em>'.
<p>
This constructor throws an <em>Exception</em> exception if it did not
        properly complete.
<p>
<li> <strong>SocketBase(int socket, sockaddr_in const &amp;address)</strong>:<br>
       This constructor constructs a <strong>FBB::SocketBase</strong> object initializing
        its socket and <strong>FBB::InetAddress</strong> part from available external
        objects.
    </ul>
<p>
The (public) copy constructor is available.
<p>
<h2>MEMBER FUNCTIONS</h2>
     All members of <strong>FBB::InetAddress</strong> are
available, as <strong>FBB::SocketBase</strong> inherits from this class.
    <ul>
    <li> <strong>bool debug() const</strong>:<br>
        This accessor returns <strong>true</strong> if the socket's <em>debug</em>
(<strong>SO_DEBUG</strong>) socket option is active. It throws an <strong>FBB::Exception</strong> exception
if the status of the debug option could not be determined.
    <li> <strong>bool reuse() const</strong>:<br>
        This accessor returns <strong>true</strong> if the socket's <em>reuse</em>
(<strong>SO_REUSEADDR</strong>) socket option is active. It throws an <strong>FBB::Exception</strong>
exception if the status of the reuse option could not be determined.
    <li> <strong>void setDebug(bool trueIsOn) const</strong>:<br>
        This member may be used to modify the socket's <em>debug</em>
(<strong>SO_DEBUG</strong>) socket option. It throws an <strong>FBB::Exception</strong> exception
if the socket's debug option could not be modified.
    <li> <strong>void setReuse(bool trueIsOn) const</strong>:<br>
        This member may be used to modify the socket's <em>reuse</em>
(<strong>SO_REUSEADDR</strong>) socket option. It throws an <strong>FBB::Exception</strong> exception
if the socket's reuse option could not be modified.
    <li> <strong>int socket() const</strong>:<br>
        This accessor returns the <strong>FBB::SocketBase</strong>'s socket value.
    <li> <strong>void verify() const</strong>:<br>
        Obsoleted, will be removed in a future Bobcat release.
    </ul>
<p>
<h2>EXAMPLE</h2>
    The classes <em>FBB::ClientSocket</em> and <em>FBB::ServerSocket</em> were derived
from <em>SocketBase</em>. E.g.,
    <pre>
#ifndef INCLUDED_BOBCAT_CLIENTSOCKET_
#define INCLUDED_BOBCAT_CLIENTSOCKET_

#include &lt;string&gt;
#include &lt;bobcat/socketbase&gt;

namespace FBB
{

class ClientSocket: public SocketBase
{
    public:
                                // host may be address or name
        ClientSocket(std::string const &amp;host, uint16_t port);

        int connect();          // returns fd (socket) to talk to the server
};

} // FBB

#endif
</pre>

<p>
See the <strong>clientsocket</strong>(3bobcat) man-page for an example showing how to
use <em>FBB::ClientSocket</em>.
<p>
<h2>FILES</h2>
    <em>bobcat/socketbase</em> - defines the class interface
<p>
<h2>SEE ALSO</h2>
    <strong>bobcat</strong>(7), <strong>clientsocket</strong>(3bobcat), <strong>inetaddress</strong>(3bobcat),
    <strong>localsocketbase</strong>(3bobcat), <strong>serversocket</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>

APT Browse - Built by Thomas Orozco.