libbobcat-dev 3.19.01-1ubuntu1 / usr / share / doc / libbobcat3-dev / man / serversocket.3.html

This file is indexed.

/usr/share/doc/libbobcat3-dev/man/serversocket.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
<html><head>
<title>FBB::ServerSocket</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::ServerSocket</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::ServerSocket(3bobcat)</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::ServerSocket(3bobcat)</h1>
<h2>libbobcat-dev_3.19.01-x.tar.gz Server Socket</h2>
<h2>2005-2013</h2>


<p>
<h2>NAME</h2>FBB::ServerSocket - Server socket accepting Internet connection requests
<p>
<h2>SYNOPSIS</h2>
    <strong>#include &lt;bobcat/serversocket&gt;</strong><br>
    Linking option: <em>-lbobcat</em> 
<p>
<h2>DESCRIPTION</h2>
    An <strong>FBB::ServerSocket</strong> may be constructed to listen for connection
requests from the Internet or from the local host. Connection requests may be
accepted in either <em>blocking</em> or <em>non-blocking</em> modes. When a connection
is accepted a socket is returned which may be used to read information from or
write information to the client that requested the connection. The socket that
is made available is a <em>file descriptor</em> which 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 client process; the <strong>std::ostream</strong> is used to send
information to the client process.  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::SocketBase</strong>
<p>
<h2>CONSTRUCTOR</h2>
    <ul>
    <li> <strong>ServerSocket(size_t  port)</strong>:<br>
        This constructor initializes an <strong>FBB::ServerSocket</strong> object, which
will listen for connections at the specified port.  The construction of the
socket does not mean that the <strong>FBB::ServerSocket</strong> object is actually
listening for connections. To start listening, the member <strong>listen()</strong> should
be used.
    </ul>
    The copy constructor is not available.
<p>
<h2>MEMBER FUNCTIONS</h2>
     All members of <strong>FBB::SocketBase</strong> (and thus of <strong>FBB::InetAddress</strong>) are
available, as <strong>FBB::ServerSocket</strong> inherits from <strong>FBB::SocketBase</strong>.
    <ul>
    <li> <strong>void listen(size_t backlog = 5, bool blocking = true)</strong>:<br>
        The <strong>listen()</strong> member defines the way the <strong>FBB::ServerSocket</strong> will
listen for clients requesting a connection.  It can be used only once with a
<strong>FBB::ServerSocket</strong>. An <strong>FBB::Exception</strong> object is thrown if listening fails,
if the constructor could not create a socket, or if the <strong>SocketBase</strong> base
class could not properly be constructed.
<p>
The <strong>listen()</strong> member's <em>backlog</em> parameter defines the size of the
<strong>FBB::ServerSocket</strong>'s internal queue in which connection requests may be
stored waiting for their turn to be serviced. When <em>backlog</em> requests are
waiting and another request arrives, then that request is lost. 
<p>
The member's second parameter, <em>blocking</em>, is used to control the
blocking mode. By default, blocking is used, and <em>listen()</em> will wait until
a connection is established. This is ok in situations where clients connect
infrquently and for relatively short time intervals. Otherwise, in more
complex programs, an <strong>FBB::Selector</strong> object can be used to sense input on
the server socket and/or on various client sockets.
<p>
<li> <strong>SocketBase accept()</strong>:<br>
        The <strong>accept()</strong> member returns an <strong>FBB::SocketBase</strong> object
containing information about the client whose connection request was
accepted. The <strong>FBB::SocketBase</strong> object's socket value may be used to
initialize streams that can be used to communicate with the client. In more
complex programs the <strong>FBB::SocketBase</strong> could be passed to a class derived
from <strong>FBB::Fork</strong>, handling the communication with the child as a separate
(child) process. 
    </ul>
<p>
<h2>EXAMPLE</h2>
    See also the <strong>clientsocket</strong>(3bobcat) example.
        <pre>

    #include &lt;iostream&gt;
    #include &lt;bobcat/serversocket&gt;
    #include &lt;bobcat/ifdstream&gt;
    #include &lt;bobcat/ofdstream&gt;
    
    #include &lt;bobcat/a2x&gt;
    
    using namespace std;
    using namespace FBB;
    
    int main(int argc, char **argv)
    try
    {
        if (argc == 1)
        {
            cerr &lt;&lt; "Provide server port number\n";
            return 1;
        }
    
        size_t portnr = A2x(argv[1]);
    
        ServerSocket server(portnr);
    
        cerr &lt;&lt; "server listens on port " &lt;&lt; argv[1] &lt;&lt; endl;
    
        cerr &lt;&lt; "serversocket returns:\n" &lt;&lt;
            "address = " &lt;&lt; server.dottedDecimalAddress() &lt;&lt; "\n"
            "port    = " &lt;&lt; server.port() &lt;&lt; endl;
    
        int fd = server.socket();       // open the socket's descriptor
    
        cout &lt;&lt; "File descriptor of the socket is " &lt;&lt; fd &lt;&lt; "\n"
            "The server terminates when it receives a "
                                        "single `q' on a line\n"
            "A connection is terminated when no input "
                                        "is received anymore.\n"
            "Then another connection is possible" &lt;&lt; endl;
    
        server.listen();                // listen in blocking mode
    
        while (true)
        {
            SocketBase fdb = server.accept();
            int fd = fdb.socket();
    
            cerr &lt;&lt; "Client FD = " &lt;&lt; fd &lt;&lt; ", " &lt;&lt; endl &lt;&lt;
                    "address = " &lt;&lt; fdb.dottedDecimalAddress() &lt;&lt; ", " &lt;&lt; 
                    endl &lt;&lt;
                    "communication through port " &lt;&lt; fdb.port() &lt;&lt; endl;
    
            IFdStream in(fd);           // stream to read from client
            OFdStream out(fd);          // stream to write to client
            string cmd;
            
            while (getline(in, cmd))
            {
                cout &lt;&lt; "Got: " &lt;&lt; cmd &lt;&lt; endl;
                out &lt;&lt; "Got: " &lt;&lt; cmd &lt;&lt; "\r" &lt;&lt; endl;
    
                if (cmd[0] == 'q')
                    return 0;
            }
            cout &lt;&lt; "Ready for another connection\n";
        }
    }
    catch (Exception const &amp;err)
    {
        cerr &lt;&lt;
            err.what() &lt;&lt; endl &lt;&lt;
            "Server socket on port " &lt;&lt; argv[1] &lt;&lt; 
            " can't be opened" &lt;&lt; endl;
        return -1;
    }        
        
</pre>

<p>
<h2>FILES</h2>
    <em>bobcat/serversocket</em> - defines the class interface
<p>
<h2>SEE ALSO</h2>
    <strong>bobcat</strong>(7), <strong>clientsocket</strong>(3bobcat), <strong>fork</strong>(3bobcat),
<strong>ifdstream</strong>(3bobcat), <strong>ifdstreambuf</strong>(3bobcat), <strong>inetaddress</strong>(3bobcat),
<strong>localserversocket</strong>(3bobcat), <strong>ofdstream</strong>(3bobcat),
<strong>ofdstream</strong>(3bobcat), <strong>select</strong>(2), <strong>selector</strong>(3bobcat),
<strong>socketbase</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>

APT Browse - Built by Thomas Orozco.