wyipaddr4.3wy

一个不错

.\"
.\" Edited by I.J.Wang, 2005
.\"
.TH IPAddr 3wy "libwy v0.31"
.SH NAME
WySockAddrINet4::IPAddr \- class of IPv4 address
.SH SYNOPSIS
.B #include <wysockaddrinet4.h>
.PP
WySockAddrINet4::IPAddr is a discardable class for
struct ::in_addr.

Documentation following omited the scope name WySockAddrINet4:: for each
occurrence of IPAddr for clearity.
.SH "PUBLIC MEMBERS"
 class \fBReply\fP : public WyRet
 \fBIPAddr\fP() throw()
 \fBIPAddr\fP(const IPAddr&) throw()
 \fBIPAddr\fP(const ::in_addr&) throw()
 \fBIPAddr\fP(uint32_t) throw()
 \fBIPAddr\fP(const char*)
 \fBIPAddr\fP(const WyStr&)
 \fBIPAddr\fP(IPAddr&, Wy::ByMove_t) throw()
 bool \fBis_default\fP(void) const throw()
 ::in_addr \fBc_addr\fP(void) const throw()
 WyRet \fBnotation\fP(WyStr&) const
 void \fBreset\fP(void) throw()
 void \fBreset\fP(const IPAddr&) throw()
 void \fBreset\fP (const ::in_addr&) throw()
 void \fBreset\fP (uint32_t) throw()
 WyRet \fBreset\fP (const char*)
 WyRet \fBreset\fP (const WyStr&)
 void \fBswap\fP(IPAddr&) throw()
 const IPAddr& \fBoperator =\fP(const IPAddr&) throw()

 bool \fBoperator ==\fP(const IPAddr&) const throw()
 bool \fBoperator !=\fP(const IPAddr&) const throw()
 bool \fBoperator ==\fP(const ::in_addr&) const throw()
 bool \fBoperator !=\fP(const ::in_addr&) const throw()
 bool \fBoperator ==\fP(uint32_t) const throw()
 bool \fBoperator !=\fP(uint32_t) const throw()
 bool \fBoperator ==\fP(const WyStr&) const
 bool \fBoperator !=\fP(const WyStr&) const
 bool \fBoperator ==\fP(const char*) const
 bool \fBoperator !=\fP(const char*) const
.SH "AUXILIARY FUNCTIONS"
 bool \fBoperator ==\fP(const ::in_addr&,const IPAddr&) throw()
 bool \fBoperator !=\fP(const ::in_addr&,const IPAddr&) throw()
 bool \fBoperator ==\fP(uint32_t,const IPAddr&) throw()
 bool \fBoperator !=\fP(uint32_t,const IPAddr&) throw()
 bool \fBoperator ==\fP(const WyStr&,const IPAddr&)
 bool \fBoperator !=\fP(const WyStr&,const IPAddr&)
 bool \fBoperator ==\fP(const char*,const IPAddr&)
 bool \fBoperator !=\fP(const char*,const IPAddr&)
.SH "DESCRIPTION"
.\"--------------------------------------------
.PP
.BI "class Reply : public WyRet
.PP
    Class specific throw type
.\"--------------------------------------------
.PP
.BI "IPAddr() throw()"
.PP
    Construct default object.

      c_addr()= ::in_addr(INADDR_ANY)
.\"--------------------------------------------
.PP
.BI "IPAddr(const IPAddr& " "addr" ") throw()"
.PP
    Construct object by copy from \fIaddr\fP

      c_addr()= \fIaddr\fP.c_addr()
.\"--------------------------------------------
.PP
.BI "IPAddr(const ::in_addr& " "addr" ") throw()"
.PP
    Construct object by \fIaddr\fP

      c_addr()= \fIaddr\fP
.\"--------------------------------------------
.PP
.BI "IPAddr(uint32_t " "addr" ") throw()"
.PP
    Construct object by \fIaddr\fP (host format)

      c_addr()= converted from \fIaddr\fP
.PP 
    [\fBRefer\fP] ::htonl(uint32_t)
.\"--------------------------------------------
.PP
.BI "IPAddr(const WyStr& " "str" ")"
.PP
    Construct IPv4 address from the string notation \fIstr\fP

      c_addr()= converted from \fIstr\fP
.PP
    [\fBThrow\fP] Reply
            Wym_EADDRNOTAVAIL Notation not recognizable
            Wym_EAFNOSUPPORT  Address family not supported
            Wym_ENOMEM        Not enough memory
.PP 
    [\fBRefer\fP] ::inet_ntop(int,const void*,char*,size_t)
.\"--------------------------------------------
.PP
.BI "IPAddr(const char* " "cstr" ")"
.PP
    Construct IPv4 address from the zero-terminated notation 
    pointed by \fIcstr\fP

      c_addr()= converted from \fIcstr\fP
.PP
    [\fBThrow\fP] Reply
            Wym_EFAULT        \fIcstr\fP is inaccessible
            Wym_EADDRNOTAVAIL Notation not recognizable
            Wym_EAFNOSUPPORT  Address family not supported
            Wym_ENOMEM        Not enough memory
.PP 
    [\fBRefer\fP] ::inet_pton(int,const char*,void*)
.\"--------------------------------------------
.PP
.BI "IPAddr(IPAddr& " "src" ", Wy::ByMove_t) throw()"
.PP
    See Wy_Array(Wy_Array&, Wy::ByMove_t) in wy_array(3wy)
    for definition of the move constructor.
.\"--------------------------------------------
.PP
.BI "bool is_default(void) const throw()"
.PP
    Is *this equivalent to the default object
.PP
    [\fBRet\fP] true= *this is equivalent to IPAddr()
         false= otherwise
.\"--------------------------------------------
.PP
.BI "::in_addr c_addr(void) const throw()"
.PP
    Get the protocol address of *this
.PP
    [\fBRet\fP] Protocol address of *this
.\"--------------------------------------------
.PP
.BI "WyRet notation(WyStr& " "buf" ") const"
.PP
    Get address text notation of *this and reset \fIbuf\fP with
    the result in dotted-decimal notation.

    Note: data buffer of \fIbuf\fP may change
.PP 
    [\fBRet\fP] Ok              Succeed
          Wym_ENOMEM      Not enough memory
.PP 
    [\fBRefer\fP] ::inet_ntop(int,const void*,char*,size_t)
.\"--------------------------------------------
.PP
.BI "void reset(void) throw()"
.PP
    Reconstruct *this to the state as IPAddr()
.\"--------------------------------------------
.PP
.BI "void reset(const IPAddr& " "addr" ") throw()"
.PP
    Reconstruct *this to the state as IPAddr(\fIaddr\fP)
.\"--------------------------------------------
.PP
.BI "void reset(const ::in_addr& " "addr" ") throw()"
.PP
    Reconstruct *this to the state as IPAddr(\fIaddr\fP)
.\"--------------------------------------------
.PP
.BI "void reset(uint32_t " "addr" ") throw()"
.PP
    Reconstruct *this to the state as IPAddr(\fIaddr\fP)
.\"--------------------------------------------
.PP
.BI "WyRet reset (const WyStr& " "str" ")"
.PP
    Reconstruct *this to the state as IPAddr(\fIstr\fP)
.PP
    [\fBRet\fP] Ok                Succeed.
          Wym_EADDRNOTAVAIL Notation not recognizable
          Wym_EAFNOSUPPORT  Address family not supported
          Wym_ENOMEM        Not enough memory
.PP 
    [\fBRefer\fP] ::inet_pton(int,const char*,void*)
.\"--------------------------------------------
.PP
.BI "WyRet reset (const char* " "cstr" ")"
.PP
    Reconstruct *this to the state as IPAddr(\fIcstr\fP)
.PP
    [\fBRet\fP] Ok                Succeed.
          Wym_EFAULT        \fIcstr\fP is inaccessible
          Wym_EADDRNOTAVAIL Notation not recognizable
          Wym_EAFNOSUPPORT  Address family not supported
          Wym_ENOMEM        Not enough memory
.PP 
    [\fBRefer\fP] ::inet_pton(int,const char*,void*)
.\"--------------------------------------------
.PP
.BI "void swap(IPAddr& " "addr" ") throw()"
.PP
    Interchange state of *this with \fIaddr\fP
.\"--------------------------------------------
.PP
.BI "const IPAddr& operator =(const IPAddr& " "addr" ") throw()"
.PP
    Assign *this to the state as IPAddr(\fIaddr\fP)
.PP 
    [\fBRet\fP] Const reference of *this
.\"--------------------------------------------
.PP 
.BI "bool operator ==(const IPAddr& " "rhs" ") const throw()"
.PP
.BI "bool operator !=(const IPAddr& " "rhs" ") const throw()"
.PP 
    Test equivalence of *this with \fIrhs\fP

    this->operator==(\fIrhs\fP) yields true iff
    this->\fBc_addr\fP()==\fIrhs\fP.\fBc_addr\fP()
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.PP 
.BI "bool operator ==(const ::in_addr& " "rhs" ") const throw()"
.PP
.BI "bool operator !=(const ::in_addr& " "rhs" ") const throw()"
.PP 
.BI "bool operator ==(uint32_t " "rhs" ") const throw()"
.PP
.BI "bool operator !=(uint32_t " "rhs" ") const throw()"
.PP 
    Test equivalence of *this with IPAddr(\fIrhs\fP)
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.PP 
.BI "bool operator ==(const char* " "rhs" ") const"
.PP
.BI "bool operator !=(const char* " "rhs" ") const"
.PP 
.BI "bool operator ==(const WyStr& " "rhs" ") const"
.PP
.BI "bool operator !=(const WyStr& " "rhs" ") const"
.PP 
    Test equivalence of *this with IPAddr(\fIrhs\fP)
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.PP 
    [\fBRefer\fP] ::inet_pton(int,const char*,void*)
.\"--------------------------------------------
.SH "AUXILIARY FUNCTIONS"
.PP 
.BI "bool operator ==(const ::in_addr& " "lhs" ", const IPAddr& " "rhs" ") throw()"
.PP
.BI "bool operator !=(const ::in_addr& " "lhs" ", const IPAddr& " "rhs" ") throw()"
.PP 
.BI "bool operator ==(uint32_t " "lhs" ", const IPAddr& " "rhs" ") throw()"
.PP
.BI "bool operator !=(uint32_t " "lhs" ", const IPAddr& " "rhs" ") throw()"
.PP 
    Test equivalence of IPAddr(\fIlhs\fP) with \fIrhs\fP
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.PP 
.BI "bool operator ==(const char* " "lhs" ", const IPAddr& " "rhs" ")"
.PP
.BI "bool operator !=(const char* " "lhs" ", const IPAddr& " "rhs" ")"
.PP 
.BI "bool operator ==(const WyStr& " "lhs" ", const IPAddr& " "rhs" ")"
.PP
.BI "bool operator !=(const WyStr& " "lhs" ", const IPAddr& " "rhs" ")"
.PP 
    Test equivalence of IPAddr(\fIlhs\fP) with \fIrhs\fP
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.PP 
    [\fBRefer\fP] ::inet_pton(int,const char*,void*)
.\"--------------------------------------------

.SH "SEE ALSO"
.BR ip(7)
.BR wystr
.BR wysockaddrinet6
.BR wysockfile
.BR wyregfile
.BR wychrfile
.BR wyterminal
.SH NOTE
Except added by this library, replys are converted from the errno 
an underlying C library function returned. Report of such replys
are brief from Linux Programmer's Manual. See the associated man page
for details.

Project is in development, http://sourceforge.net/projects/libwx