.TH "ost::IPV4Mask" 3 "Sun Dec 27 2020" "GNU CommonC++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ost::IPV4Mask \- Internet addresses used specifically as masking addresses (such as '
255\&.255\&.255\&.0') are held in the \fBIPV4Mask\fP derived object\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <address\&.h>\fP
.PP
Inherits \fBost::IPV4Address\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBIPV4Mask\fP (const char *mask)"
.br
.RI "Create the mask from a null terminated ASCII string such as '255\&.255\&.255\&.128'\&. "
.ti -1c
.RI "\fBIPV4Address\fP & \fBoperator=\fP (unsigned long addr)"
.br
.RI "Allows assignment from the return of functions like inet_addr() or htonl() "
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "\fB__EXPORT\fP \fBIPV4Host\fP \fBoperator&\fP (const \fBIPV4Host\fP &addr, const \fBIPV4Mask\fP &mask)"
.br
.RI "Masks are usually used to coerce host addresses into a specific router or class domain\&. "
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
Internet addresses used specifically as masking addresses (such as '
255\&.255\&.255\&.0') are held in the \fBIPV4Mask\fP derived object\&. 

The separate class is used so that C++ type casting can automatically determine when an \fBIPV4Address\fP object is really a mask address object rather than simply using the base class\&. This also allows manipulative operators for address masking to operate only when presented with a Masked address as well as providing cleaner and safer source\&.
.PP
\fBAuthor\fP
.RS 4
David Sugar dyfet@ostel.com
.RE
.PP
Internet Address Mask such as subnet masks\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "ost::IPV4Mask::IPV4Mask (const char * mask)"

.PP
Create the mask from a null terminated ASCII string such as '255\&.255\&.255\&.128'\&. 
.PP
\fBParameters\fP
.RS 4
\fImask\fP null terminated ASCII mask string\&. 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBIPV4Address\fP& ost::IPV4Mask::operator= (unsigned long addr)\fC [inline]\fP"

.PP
Allows assignment from the return of functions like inet_addr() or htonl() 
.PP
References ost::IPV4Address::operator=()\&.
.SH "Friends And Related Function Documentation"
.PP 
.SS "\fB__EXPORT\fP \fBIPV4Host\fP operator& (const \fBIPV4Host\fP & addr, const \fBIPV4Mask\fP & mask)\fC [friend]\fP"

.PP
Masks are usually used to coerce host addresses into a specific router or class domain\&. This can be done by taking the Inet Host Address object and 'and'ing it with an address mask\&. This operation can be directly expressed in C++ through the & operator\&.
.PP
\fBReturns\fP
.RS 4
a internet host address that has been masked\&. 
.RE
.PP
\fBParameters\fP
.RS 4
\fIaddr\fP host address to be masked by subnet\&. 
.br
\fImask\fP inetnet mask address object to mask by\&. 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for GNU CommonC++ from the source code\&.