File: socketbase.yo

package info (click to toggle)
bobcat 2.08.01-1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 5,668 kB
  • ctags: 953
  • sloc: cpp: 10,403; makefile: 9,042; perl: 401; sh: 195
file content (90 lines) | stat: -rw-r--r-- 3,364 bytes parent folder | download
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
includefile(header.inc)

COMMENT(manpage, section, releasedate, archive, short name)
manpage(FBB::SocketBase)(3bobcat)(_CurYrs_)(libbobcat1-dev__CurVers_-x.tar.gz)
                    (Base class for sockets)

manpagename(FBB::SocketBase)(Base class for socket-constructing classes)

manpagesynopsis()
    bf(#include <bobcat/socketbase>)nl()
    Linking option: tt(-lbobcat) 

manpagedescription()
    This class is a base class for the bf(FBB::ServerSocket) and
bf(FBB::ClientSocket) classes. Since it is designed as a base class, all its
constructors are protected.

includefile(namespace.inc)

manpagesection(INHERITS FROM)
    bf(FBB::InetAddress)

manpagesection(PROTECTED CONSTRUCTORS)
    itemization(
    itb(SocketBase(size_t port)) 
        This constructor creates a bf(SocketBase) to be used with
bf(ServerSocket)-objects, listening on tt(port).  

        This constructor throws an tt(Errno) exception if it did not properly
complete.

    itb(SocketBase(std::string const &host, unit_16_t port)) 
        This constructor creates a bf(FBB::SocketBase) to be used with a
bf(ClientSocket)-object, connecting to tt(hostname), at port `tt(port)'. 

        This constructor throws an tt(Errno) exception if it did not properly
complete.


    itb(SocketBase(int socket, sockaddr_in const &address))
        This constructor constructs a bf(FBB::SocketBase) object initializing
its socket and bf(FBB::InetAddress) part from available external objects.
    )
    The (public) copy constructor is available.

manpagesection(MEMBER FUNCTIONS)
     All members of bf(FBB::InetAddress) are
available, as bf(FBB::SocketBase) inherits from this class.
    itemization(
    itb(bool debug() const)
        This accessor returns bf(true) if the socket's em(debug)
(bf(SO_DEBUG)) socket option is active. It throws an bf(FBB::Errno) exception
if the status of the debug option could not be determined.
    itb(bool reuse() const)
        This accessor returns bf(true) if the socket's em(reuse)
(bf(SO_REUSEADDR)) socket option is active. It throws an bf(FBB::Errno)
exception if the status of the reuse option could not be determined.
    itb(void setDebug(bool trueIsOn) const)
        This member may be used to modify the socket's em(debug)
(bf(SO_DEBUG)) socket option. It throws an bf(FBB::Errno) exception
if the socket's debug option could not be modified.
    itb(void setReuse(bool trueIsOn) const)
        This member may be used to modify the socket's em(reuse)
(bf(SO_REUSEADDR)) socket option. It throws an bf(FBB::Errno) exception
if the socket's reuse option could not be modified.
    itb(int socket() const)
        This accessor returns the bf(FBB::SocketBase)'s socket value.
    itb(void verify() const)
        Obsoleted, will be removed in a future Bobcat release.
    )

manpagesection(EXAMPLE)
    The classes tt(FBB::ClientSocket) and tt(FBB::ServerSocket) were derived
from tt(SocketBase). E.g.,
    verbinclude(../../clientsocket/clientsocket)
    
    See the bf(clientsocket)(3bobcat) man-page for an example showing how to
use tt(FBB::ClientSocket).

manpagefiles()
    em(bobcat/socketbase) - defines the class interface

manpageseealso()
    bf(bobcat)(7), bf(clientsocket)(3bobcat), bf(inetaddress)(3bobcat),
    bf(localsocketbase)(3bobcat), bf(serversocket)(3bobcat)

manpagebugs()
    None Reported.

includefile(trailer.inc)