.TH "FBB::LocalSocketBase" "3bobcat" "2005\-2023" "libbobcat\-dev_6\&.04\&.00" "Base class for Unix Domain sockets"

.PP 
.SH "NAME"
FBB::LocalSocketBase \- Base class for Unix Domain socket\-constructing classes
.PP 
.SH "SYNOPSIS"
\fB#include <bobcat/localsocketbase>\fP
.br 
Linking option: \fI\-lbobcat\fP
.PP 
.SH "DESCRIPTION"
This class is a base class for the \fBFBB::LocalServerSocket\fP and
\fBFBB::LocalClientSocket\fP classes\&. Since it is designed as a base class,
its constructor is protected\&. All its remaining members are protected as well\&.
.PP 
.SH "NAMESPACE"
\fBFBB\fP
.br 
All constructors, members, operators and manipulators, mentioned in this
man\-page, are defined in the namespace \fBFBB\fP\&.
.PP 
.SH "INHERITS FROM"
\-
.PP 
.SH "PROTECTED CONSTRUCTOR"
.IP o 
\fBLocalSocketBase()\fP:
.br 
The default constructor merely constructs a \fIFBB::LocalSocketBase\fP
object\&. Before the object can be used, its \fIopen()\fP member must be called
first\&.
.IP o 
\fBLocalSocketBase(string const &name)\fP:
.br 
This constructor creates a \fBLocalSocketBase\fP using the file
specified in \fIname\fP as the Unix domain socket interface\&.  If the socket
could not be constructed, an \fBFBB::Exception\fP exception is thrown\&.

.PP 
Copy and move constructors (and assignment operators) are not available\&.
.PP 
.SH "PROTECTED MEMBER FUNCTIONS"
.IP o 
\fBopen(string const &name)\fP:
.br 
This member initiaizes a \fBLocalSocketBase\fP object following its
construction using the default constructor\&. The file specified in \fIname\fP is
used as the Unix domain socket interface\&.  If the socket could not be
constructed, an \fBFBB::Exception\fP exception is thrown\&.
.IP o 
\fBsize_t size() const\fP:
.br 
Accessor returning the size of the object\(cq\&s \fBsockaddr_un\fP (address)
.IP o 
\fBint socket() const\fP:
.br 
This accessor returns the \fBFBB::LocalSocketBase\fP\(cq\&s socket value\&.
.IP o 
\fBsockaddr const *sockaddrPtr() const\fP:
.br 
Accessor returning the pointer to the object\(cq\&s \fBsockaddr\fP\&.

.PP 
.SH "EXAMPLE"
See the examples presented with the \fBlocalclientsocket\fP(3bobcat) and
\fBlocalserversocket\fP(3bobcat) classes\&.
.PP 
.SH "FILES"
\fIbobcat/localsocketbase\fP \- defines the class interface
.PP 
.SH "SEE ALSO"
\fBbobcat\fP(7), \fBlocalclientsocket\fP(3bobcat),
\fBlocalserversocket\fP(3bobcat), \fBsocketbase\fP(3bobcat)
.PP 
.SH "BUGS"
None Reported\&.
.PP 
.SH "BOBCAT PROJECT FILES"

.PP 
.IP o 
\fIhttps://fbb\-git\&.gitlab\&.io/bobcat/\fP: gitlab project page;
.IP o 
\fIbobcat_6\&.04\&.00\-x\&.dsc\fP: detached signature;
.IP o 
\fIbobcat_6\&.04\&.00\-x\&.tar\&.gz\fP: source archive;
.IP o 
\fIbobcat_6\&.04\&.00\-x_i386\&.changes\fP: change log;
.IP o 
\fIlibbobcat1_6\&.04\&.00\-x_*\&.deb\fP: debian package containing the
libraries;
.IP o 
\fIlibbobcat1\-dev_6\&.04\&.00\-x_*\&.deb\fP: debian package containing the
libraries, headers and manual pages;

.PP 
.SH "BOBCAT"
Bobcat is an acronym of `Brokken\(cq\&s Own Base Classes And Templates\(cq\&\&.
.PP 
.SH "COPYRIGHT"
This is free software, distributed under the terms of the
GNU General Public License (GPL)\&.
.PP 
.SH "AUTHOR"
Frank B\&. Brokken (\fBf\&.b\&.brokken@rug\&.nl\fP)\&.
.PP