wysockaddrlocal.3wy

一个不错

.\"
.\" Edited by I.J.Wang, 2004
.\"
.TH WySockAddrLocal 3wy "libwy v0.31"
.SH NAME
WySockAddrLocal \- class of an socket address
.SH SYNOPSIS
.B #include <wysockaddrlocal.h>
.PP
[\fBInherit\fP] Wy_SockAddr (protocol class)
.PP
WySockAddrLocal is a discardable class for Unix domain socket address
 (wrapper of struct sockaddr_un, family= AF_LOCAL).
.SH "PUBLIC MEMBERS"
 class \fBReply\fP : public WyRet
 static const size_t \fBPathMaxLen\fP
 static int \fBfamily\fP(void) throw()
 \fBWySockAddrLocal\fP() throw()
 \fBWySockAddrLocal\fP(const WySockAddrLocal&) throw()
 \fBWySockAddrLocal\fP(const ::sockaddr_un&,size_t) throw(WyRet)
 \fBWySockAddrLocal\fP(const char*) throw(WyRet)
 \fBWySockAddrLocal\fP(const WyStr&) throw(WyRet)
 \fBWySockAddrLocal\fP(const WyCSeg&) throw(WyRet)
 \fBWySockAddrLocal\fP(WySockAddrLocal&, Wy::ByMove_t) throw()
 bool \fBis_default\fP(void) const throw()
 WyCSeg \fB_path\fP(void) const throw()
 virtual WyRet \fBnotation\fP(WyStr&) const
 virtual void \fBreset\fP(void) throw()
 virtual void \fBreset\fP(const WySockAddrLocal&) throw()
 virtual WyRet \fBreset\fP(const ::sockaddr_un&,size_t) throw()
 virtual WyRet \fBreset\fP(const char*) throw()
 virtual WyRet \fBreset\fP(const WyStr&) throw()
 virtual WyRet \fBreset\fP(const WyCSeg&) throw()
 virtual WyRet \fB_swap\fP(Wy_SockAddr&) throw()
 virtual WySockAddrLocal* \fB_alloc\fP(WyRet&) const
 virtual const WySockAddrLocal& \fBoperator =\fP(const WySockAddrLocal&) throw()
 virtual const WySockAddrLocal& \fBoperator =\fP(const char*) throw(WyRet)
 virtual const WySockAddrLocal& \fBoperator =\fP(const WyStr&) throw(WyRet)
 virtual const WySockAddrLocal& \fBoperator =\fP(const WyCSeg&) throw(WyRet)
 bool \fBoperator ==\fP(const WySockAddrLocal&) const throw()
 bool \fBoperator !=\fP(const WySockAddrLocal&) const throw()
 bool \fBoperator ==\fP(const char*) const throw(Reply)
 bool \fBoperator !=\fP(const char*) const throw(Reply)
 bool \fBoperator ==\fP(const WyStr&) const throw()
 bool \fBoperator !=\fP(const WyStr&) const throw()
 bool \fBoperator ==\fP(const WyCSeg&) const throw()
 bool \fBoperator !=\fP(const WyCSeg&) const throw()
.SH "AUXILIARY FUNCTIONS"
 bool \fBoperator ==\fP(const char*,const WySockAddrLocal&) throw(WySockAddrLocal::Reply)
 bool \fBoperator !=\fP(const char*,const WySockAddrLocal&) throw(WySockAddrLocal::Reply)
 bool \fBoperator ==\fP(const WyStr&,const WySockAddrLocal&) throw()
 bool \fBoperator !=\fP(const WyStr&,const WySockAddrLocal&) throw()
 bool \fBoperator ==\fP(const WyCSeg&,const WySockAddrLocal&) throw()
 bool \fBoperator !=\fP(const WyCSeg&,const WySockAddrLocal&) throw()
.SH "DESCRIPTION"
.\"--------------------------------------------
.PP
.BI "class Reply : public WyRet"
.PP
    Class specific throw type
.\"--------------------------------------------
.PP
.BI "static const size_t PathMaxLen"
.PP
    The maximal length of address WySockAddrLocal can take
.\"--------------------------------------------
.PP
.BI "static int family(void) throw()"
.PP
    Get socket address family
.PP 
    [\fBRet\fP] Always AF_LOCAL
.\"--------------------------------------------
.PP
.BI "WySockAddrLocal() throw()"
.PP
    Construct default object.

      _path()= ""
.\"--------------------------------------------
.PP
.BI "WySockAddrLocal(const WySockAddrLocal& " "addr" ") throw()"
.PP
    Construct object by copy from \fIaddr\fP

      _path()= equivalent to \fIaddr\fP._path()
.\"--------------------------------------------
.PP
.BI "WySockAddrLocal(const ::sockaddr_un& " "addr" ", size_t " "len" ") throw(WyRet)"
.PP
    Construct object from \fIaddr\fP and the actual length \fIlen\fP of \fIaddr\fP

      _path()= equivalent to the pathname address indicated by
               \fIaddr\fP and \fIlen\fP

      Note: \fIaddr\fP.sun_family is ignored
.PP
    [\fBThrow\fP] Reply
            Wym_EINVAL      \fIlen\fP is invalid
.\"--------------------------------------------
.PP
.BI "WySockAddrLocal(const char* " "addr" ") throw(WyRet)"
.PP
    Construct object of the address from \fIaddr\fP pointed
    zero-terminated string

      _path()= equivalent to WyCSeg(\fIaddr\fP)
.PP
    [\fBThrow\fP] Reply
            Wym_ENAMETOOLONG \fIaddr\fP too long
            Wym_EFAULT       \fIaddr\fP is inaccessible
.\"--------------------------------------------
.PP
.BI "WySockAddrLocal(const WyStr& " "addr" ") throw(WyRet)"
.PP
    Construct object of the address from \fIaddr\fP

      _path()= equivalent to \fIaddr\fP.cseg()
.PP
    [\fBThrow\fP] Reply
            Wym_ENAMETOOLONG \fIaddr\fP too long
.\"--------------------------------------------
.PP
.BI "WySockAddrLocal(const WyCSeg& " "addr" ") throw(WyRet)"
.PP
    Construct object of the address from \fIaddr\fP

      _path()= equivalent to \fIaddr\fP
.PP
    [\fBThrow\fP] Reply
            Wym_ENAMETOOLONG \fIaddr\fP too long
.\"--------------------------------------------
.PP
.BI "WySockAddrLocal(WySockAddrLocal& " "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 WySockAddrLocal()
         false= otherwise
.\"--------------------------------------------
.PP
.BI "WyCSeg _path(void) const throw()"
.PP
    Get WyCSeg object pointing to the pathname address

    Note: WyCSeg says nothing of the trailing character.
.PP 
    [\fBRet\fP] WyCSeg object points to the pathname address in *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.

    Note: data buffer of \fIbuf\fP may change
.PP 
    [\fBRet\fP] Ok              Succeed
          Wym_ENOMEM      Not enough memory
.\"--------------------------------------------
.PP
.BI "virtual void reset(void) throw()"
.PP
    Reconstruct *this to the state as WySockAddrLocal()
.\"--------------------------------------------
.PP
.BI "virtual void reset(const WySockAddrLocal& " "addr" ") throw()"
.PP
    Reconstruct *this to the state as WySockAddrLocal(\fIaddr\fP)
.\"--------------------------------------------
.PP
.BI "virtual WyRet reset(const ::sockaddr_un& " "addr" ", size_t " "len" ") throw()"
.PP
    Reconstruct *this to the state as WySockAddrLocal(\fIaddr\fP,\fIlen\fP)

    Note: \fIaddr\fP.sun_family is ignored
.PP 
    [\fBRet\fP] Ok              Succeed.
          Wym_EINVAL      \fIlen\fP is invalid
.\"--------------------------------------------
.PP
.BI "virtual WyRet reset(const char* " "addr" ") throw()"
.PP
    Reconstruct *this to the state as WySockAddrLocal(\fIaddr\fP)
.PP 
    [\fBRet\fP] Ok              Succeed.
          Wym_EFAULT       \fIaddr\fP is inaccessible
          Wym_ENAMETOOLONG \fIaddr\fP too long
.\"--------------------------------------------
.PP
.BI "virtual WyRet reset(const WyStr& " "addr" ") throw()"
.PP
    Reconstruct *this to the state as WySockAddrLocal(\fIaddr\fP)
.PP 
    [\fBRet\fP] Ok              Succeed.
          Wym_ENAMETOOLONG \fIaddr\fP is too long
.\"--------------------------------------------
.PP
.BI "virtual WyRet reset(const WyCSeg& " "addr" ") throw()"
.PP
    Reconstruct *this to the state as WySockAddrLocal(\fIaddr\fP)
.PP 
    [\fBRet\fP] Ok              Succeed.
          Wym_ENAMETOOLONG \fIaddr\fP is too long
.\"--------------------------------------------
.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 WySockAddrLocal* _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 WySockAddrLocal()
.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 WySockAddrLocal& operator =(const WySockAddrLocal& " "addr" ") throw()"
.PP
    Assign *this as by WySockAddrLocal(\fIaddr\fP)
.PP 
    [\fBRet\fP] Const reference of *this
.\"--------------------------------------------
.PP
.BI "virtual const WySockAddrLocal& operator =(const char* " "addr" ") throw(WyRet)"
.PP
    Assign *this as by WySockAddrLocal(\fIaddr\fP)
.PP
    [\fBThrow\fP] Reply
            Wym_EFAULT       \fIaddr\fP is inaccessible
            Wym_ENAMETOOLONG \fIaddr\fP too long
.PP 
    [\fBRet\fP] Const reference of *this
.\"--------------------------------------------
.PP
.BI "virtual const WySockAddrLocal& operator =(const WyStr& " "addr" ") throw(WyRet)"
.PP
    Assign *this as by WySockAddrLocal(\fIaddr\fP)
.PP
    [\fBThrow\fP] Reply
            Wym_ENAMETOOLONG \fIaddr\fP too long
.PP 
    [\fBRet\fP] Const reference of *this
.\"--------------------------------------------
.PP
.BI "virtual const WySockAddrLocal& operator =(const WyCSeg& " "addr" ") throw(WyRet)"
.PP
    Assign *this as by WySockAddrLocal(\fIaddr\fP)
.PP
    [\fBThrow\fP] Reply
            Wym_ENAMETOOLONG \fIaddr\fP too long
.PP 
    [\fBRet\fP] Const reference of *this
.\"--------------------------------------------
.PP 
.BI "bool operator ==(const WySockAddrLocal& " "rhs" ") const throw()"
.PP
.BI "bool operator !=(const WySockAddrLocal& " "rhs" ") const throw()"
.PP 
    Test equivalence of *this with \fIrhs\fP

    this->operator==(\fIrhs\fP) yields true iff
    this->\fB_path\fP()==\fIrhs\fP.\fB_path\fP() yields true
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.PP 
.BI "bool operator ==(const char* " "rhs" ") const throw(Reply)"
.PP
.BI "bool operator !=(const char* " "rhs" ") const throw(Reply)"
.PP 
    Test equivalence of *this with WySockAddrLocal(\fIrhs\fP)
.PP
    [\fBThrow\fP] Reply
            Wym_EFAULT       \fIrhs\fP is inaccessible
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.PP 
.BI "bool operator ==(const WyStr& " "rhs" ") const throw()"
.PP
.BI "bool operator !=(const WyStr& " "rhs" ") const throw()"
.PP 
.BI "bool operator ==(const WyCSeg& " "rhs" ") const throw()"
.PP
.BI "bool operator !=(const WyCSeg& " "rhs" ") const throw()"
.PP 
    Test equivalence of *this with WySockAddrLocal(\fIrhs\fP)
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.SH "AUXILIARY FUNCTIONS"
.PP
.BI "bool operator ==(const char* " "lhs" ", const WySockAddrLocal& " "rhs" ") throw(WySockAddrLocal::Reply)"
.PP
.BI "bool operator !=(const char* " "lhs" ", const WySockAddrLocal& " "rhs" ") throw(WySockAddrLocal::Reply)"
.PP
    Test equivalence of WySockAddrLocal(\fIlhs\fP) with \fIrhs\fP
.PP
    [\fBThrow\fP] Reply
            Wym_EFAULT       \fIlhs\fP is inaccessible
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.PP
.BI "bool operator ==(const WyStr& " "lhs" ", const WySockAddrLocal& " "rhs" ") throw()"
.PP
.BI "bool operator !=(const WyStr& " "lhs" ", const WySockAddrLocal& " "rhs" ") throw()"
.PP
    Test equivalence of WySockAddrLocal(\fIlhs\fP) with \fIrhs\fP
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.PP
.BI "bool operator ==(const WyCSeg& " "lhs" ", const WySockAddrLocal& " "rhs" ") throw()"
.PP
.BI "bool operator !=(const WyCSeg& " "lhs" ", const WySockAddrLocal& " "rhs" ") throw()"
.PP
    Test equivalence of WySockAddrLocal(\fIlhs\fP) with \fIrhs\fP
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.SH "SEE ALSO"
.BR (7)unix
.BR wysockaddrinet4
.BR wysockfile
.BR wyfifofile
.BR wy_dirfile
.BR wyregfile
.SH NOTE
Project is in development, http://sourceforge.net/projects/libwx