includefile(include/header)

COMMENT(manpage, section, releasedate, archive, short name)
manpage(FBB::LocalSocketBase)(3bobcat)(_CurYrs_)
        (libbobcat-dev__CurVers_)
                    (Base class for Unix Domain sockets)

manpagename(FBB::LocalSocketBase)
    (Base class for Unix Domain socket-constructing classes)

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

manpagedescription()
    This class is a base class for the bf(FBB::LocalServerSocket) and
bf(FBB::LocalClientSocket) classes. Since it is designed as a base class, 
its constructor is protected. All its remaining members are protected as well.

includefile(include/namespace)

manpagesection(INHERITS FROM)
    -

manpagesection(PROTECTED CONSTRUCTOR)
    itemization(
    itb(LocalSocketBase()) 
        The default constructor merely constructs a tt(FBB::LocalSocketBase)
object. Before the object can be used, its tt(open()) member must be called
first. 
    itb(LocalSocketBase(string const &name)) 
        This constructor creates a bf(LocalSocketBase) using the file
specified in tt(name) as the Unix domain socket interface.  If the socket
could not be constructed, an bf(FBB::Exception) exception is thrown.
    )

    Copy and move constructors (and assignment operators) are not available.

manpagesection(PROTECTED MEMBER FUNCTIONS)
    itemization(
    itb(open(string const &name)) 
        This member initiaizes a bf(LocalSocketBase) object following its
construction using the default constructor. The file specified in tt(name) is
used as the Unix domain socket interface.  If the socket could not be
constructed, an bf(FBB::Exception) exception is thrown.
    itb(size_t size() const)
        Accessor returning the size of the object's bf(sockaddr_un) (address)
    itb(int socket() const)
        This accessor returns the bf(FBB::LocalSocketBase)'s socket value.
    itb(sockaddr const *sockaddrPtr() const)
        Accessor returning the pointer to the object's bf(sockaddr). 
    )

manpagesection(EXAMPLE)
    See the examples presented with the bf(localclientsocket)(3bobcat) and 
    bf(localserversocket)(3bobcat) classes.

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

manpageseealso() 
    bf(bobcat)(7), bf(localclientsocket)(3bobcat),
    bf(localserversocket)(3bobcat), bf(socketbase)(3bobcat)

manpagebugs()
    None Reported.

includefile(include/trailer)
