wysockaddrinet6.3wy

一个不错

.\"
.\" Edited by I.J.Wang, 2004
.\"
.TH WySockAddrINet6 3wy "libwy v0.31"
.SH NAME
WySockAddrINet6 \- class of socket address
.SH SYNOPSIS
.B #include <wysockaddrinet6.h>
.PP
[\fBInherit\fP] Wy_SockAddr (protocol class)
.PP
WySockAddrINet6 is a discardable class for IPv6 socket address 
 (wrapper of struct ::sockaddr_in6 ,family= AF_INET6).
.SH "PUBLIC MEMBERS"
 static int \fBfamily\fP(void) throw()
 \fBWySockAddrINet6\fP() throw()
 \fBWySockAddrINet6\fP(const WySockAddrINet6&) throw()
 \fBWySockAddrINet6\fP(const ::sockaddr_in6&) throw()
 \fBWySockAddrINet6\fP(const WySockAddrINet6::IPAddr&,uint16_t) throw()
 \fBWySockAddrINet6\fP(WySockAddrINet6&, Wy::ByMove_t) throw()
 bool \fBis_default\fP(void) const throw()
 WySockAddrINet6::IPAddr \fBip\fP(void) const throw()
 uint16_t \fBport\fP(void) const throw()
 uint32_t \fB_flowinfo\fP(void) const throw()
 uint32_t \fB_scope_id\fP(void) const throw()
 virtual WyRet \fBnotation\fP(WyStr&) const
 virtual void \fBreset\fP(void) throw()
 virtual void \fBreset\fP(const WySockAddrINet6&) throw()
 virtual void \fBreset\fP(const ::sockaddr_in6&) throw()
 virtual void \fBreset\fP(const WySockAddrINet6::IPAddr&, uint16_t) throw()
 virtual WyRet \fB_swap\fP(Wy_SockAddr&) throw()
 virtual WySockAddrINet6* \fB_alloc\fP(WyRet&) const
 virtual const WySockAddrINet6& \fBoperator =\fP(const WySockAddrINet6&) throw()
 virtual const WySockAddrINet6& \fBoperator =\fP(const ::sockaddr_in6&) throw()
 bool \fBoperator ==\fP(const WySockAddrINet6&) const throw()
 bool \fBoperator !=\fP(const WySockAddrINet6&) const throw()
 bool \fBoperator ==\fP(const ::sockaddr_in6&) const throw()
 bool \fBoperator !=\fP(const ::sockaddr_in6&) const throw()
.SH "AUXILIARY FUNCTIONS"
 bool \fBoperator ==\fP(const ::sockaddr_in6&,const WySockAddrINet6&) throw()
 bool \fBoperator !=\fP(const ::sockaddr_in6&,const WySockAddrINet6&) throw()
.SH "DESCRIPTION"
.\"--------------------------------------------
.PP
.BI "static int family(void) throw()
.PP
    Get socket address family
.PP 
    [\fBRet\fP] Always AF_INET6
.\"--------------------------------------------
.PP
.BI "WySockAddrINet6() throw()"
.PP
    Construct default object.

      ip()       = WySockAddrINet6::IPAddr()
      port()     = 0
      _flowinfo()= 0
      _scope_id()= 0

    See wyipaddr6(3wy) for WySockAddrINet6::IPAddr
.\"--------------------------------------------
.PP
.BI "WySockAddrINet6(const WySockAddrINet6& " "addr" ") throw()"
.PP
    Construct object by copy from \fIaddr\fP

      ip()       = \fIaddr\fP.ip()
      port()     = \fIaddr\fP.port()
      _flowinfo()= \fIaddr\fP._flowinfo()
      _scope_id()= \fIaddr\fP._scope_id()
.\"--------------------------------------------
.PP
.BI "WySockAddrINet6(const ::sockaddr_in6& " "addr" ") throw()"
.PP
    Construct object by copy from \fIaddr\fP

      ip()       = from \fIaddr\fP.sin6_addr
      port()     = from \fIaddr\fP.sin6_port
      _flowinfo()= from \fIaddr\fP.sin6_flowinfo
      _scope_id()= from \fIaddr\fP.sin6_scope_id

    Note: \fIaddr\fP.sin6_family is ignored
.\"--------------------------------------------
.PP
.BI "WySockAddrINet6(WySockAddrINet6::IPAddr " "ip" ",uint16_t " "port" ") throw()"
.PP
    Construct IPv6 address of *this by \fIip\fP and \fIport\fP

      ip()       = \fIip\fP
      port()     = \fIport\fP
      _flowinfo()= 0
      _scope_id()= 0

    See wyipaddr6(3wy) for WySockAddrINet6::IPAddr
.\"--------------------------------------------
.PP
.BI "WySockAddrINet6(WySockAddrINet6& " "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 WySockAddrINet6()
         false= otherwise
.\"--------------------------------------------
.PP
.BI "WySockAddrINet6::IPAddr ip(void) const throw()"
.PP
    Get the IP address of *this

    See wyipaddr6(3wy) for WySockAddrINet6::IPAddr
.PP 
    [\fBRet\fP] IP address of *this
.\"--------------------------------------------
.PP
.BI "uint16_t port(void) const throw()"
.PP
    Get the port number of *this
.PP 
    [\fBRet\fP] Port number of *this
.\"--------------------------------------------
.PP
.BI "uint32_t _flowinfo(void) const throw()"
.PP
    Get the flowinfo entity of *this
.PP 
    [\fBRet\fP] flowinfo of *this
.\"--------------------------------------------
.PP
.BI "uint32_t _scope_id(void) const throw()"
.PP
    Get the scope_id entity of *this
.PP 
    [\fBRet\fP] scope_id of *this
.\"--------------------------------------------
.PP
.BI "virtual WyRet notation(WyStr& " "buf" ") const"
.PP
    Get the socket address text notation of *this by resetting \fIbuf\fP
    with the result. The text notation is like "hh:hh:hh.port".

    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 "virtual void reset(void) throw()"
.PP
    Reconstruct *this to the state as WySockAddrINet6()
.\"--------------------------------------------
.PP
.BI "virtual void reset(const WySockAddrINet6& " "addr" ") throw()"
.PP
    Reconstruct *this to the state as WySockAddrINet6(\fIaddr\fP)
.\"--------------------------------------------
.PP
.BI "virtual void reset(const ::sockaddr_in6& " "addr" ") throw()"
.PP
    Reconstruct *this to the state as WySockAddrINet6(\fIaddr\fP)

    Note: \fIaddr\fP.sin6_family is ignored
.\"--------------------------------------------
.PP
.BI "virtual void reset(const WySockAddrINet6::IPAddr& " "ip" ", uint16_t " "port" ") throw()"
.PP
    Reconstruct *this to the state as WySockAddrINet6(\fIip\fP,\fIport\fP)
.\"--------------------------------------------
.PP
.BI "virtual WyRet _swap(Wy_SockAddr& " "addr" ") throw()"
.PP
    Interchange state of *this with \fIaddr\fP
.PP
    [\fBRet\fP] Ok              Succeed
          Wym_EBADTYPE    \fIaddr\fP is not the same type as *this
.\"--------------------------------------------
.PP
.BI "virtual WySockAddrINet6* _alloc(WyRet& " "r" ") const"
.PP
    Allocate a default object of the most inherited type that
    *this refers.

    Note: Inhertied class must override this member

    \fIr\fP is reset with the return status:
            Wym_ENOMEM      Not enough memory
            Wym_ENOSYS      *Not overridden
            ...             Same from constructing WySockAddrINet6()
.PP
    [\fBRet\fP] Pointer of the allocated object, or NULL if failed.
          User is responsible to \fBdelete\fP the returned object.
.\"--------------------------------------------
.PP
.BI "virtual const WySockAddrINet6& operator =(const WySockAddrINet6& " "addr" ") throw()"
.PP
    Assign *this to the state as WySockAddrINet6(\fIaddr\fP)
.PP 
    [\fBRet\fP] Const reference of *this
.\"--------------------------------------------
.PP
.BI "virtual const WySockAddrINet6& operator =(const ::sockaddr_in6& " "addr" ") throw()"
.PP
    Assign *this to the state as WySockAddrINet6(\fIaddr\fP)

    Note: \fIaddr\fP.sin6_family is ignored
.PP 
    [\fBRet\fP] Const reference of *this
.\"--------------------------------------------
.PP 
.BI "bool operator ==(const WySockAddrINet6& " "rhs" ") const throw()"
.PP
.BI "bool operator !=(const WySockAddrINet6& " "rhs" ") const throw()"
.PP 
    Test equivalence of *this with \fIrhs\fP

    this->operator==(\fIrhs\fP) yields true iff
      (this->\fBip\fP()==\fIrhs\fP.\fBip\fP())&&
      (this->\fBport\fP()==\fIrhs\fP.\fBport\fP())
      (this->\fB_flowinfo\fP()==\fIrhs\fP.\fB_flowinfo\fP())
      (this->\fB_scope_id\fP()==\fIrhs\fP.\fB_scope_id\fP())
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.PP 
.BI "bool operator ==(const ::sockaddr_in6& " "rhs" ") const throw()"
.PP
.BI "bool operator !=(const ::sockaddr_in6& " "rhs" ") const throw()"
.PP 
    Test equivalence of *this with WySockAddrINet6(\fIrhs\fP)

    Note: \fIrhs\fP.sin6_family is ignored
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.SH "AUXILIARY FUNCTIONS"
.PP
.BI "bool operator ==(const ::sockaddr_in6& " "lhs" ", const WySockAddrINet6& " "rhs" ") throw()"
.PP
.BI "bool operator !=(const ::sockaddr_in6& " "lhs" ", const WySockAddrINet6& " "rhs" ") throw()"
.PP
    Test equivalence of WySockAddrINet6(\fIlhs\fP) with \fIrhs\fP

    Note: \fIlhs\fP.sin_family is ignored
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------

.SH "SEE ALSO"
.BR ipv6(7)
.BR wyipaddr6
.BR wysockaddrinet4
.BR wysockaddrlocal
.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