WvStreams
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
WvError Class Reference

A variant of WvErrorBase suitable for embedding as a member of your own object, preferably called 'err'. More...

#include <wverror.h>

Inheritance diagram for WvError:
Inheritance graph
[legend]

Public Member Functions

int get () const
 
WvString str () const
 
void set (int _errnum)
 
void set (WvStringParm specialerr)
 
void set (WVSTRING_FORMAT_DECL)
 
void set_both (int _errnum, WvStringParm specialerr)
 
void set (const WvErrorBase &err)
 
void reset ()
 
int get () const
 
WvString str () const
 
void set (int _errnum)
 
void set (WvStringParm specialerr)
 
void set (WVSTRING_FORMAT_DECL)
 
void set_both (int _errnum, WvStringParm specialerr)
 
void set (const WvErrorBase &err)
 
void reset ()
 
virtual bool isok () const
 By default, returns true if geterr() == 0.
 
virtual bool isok () const
 By default, returns true if geterr() == 0.
 
virtual int geterr () const
 If isok() is false, return the system error number corresponding to the error, -1 for a special error string (which you can obtain with errstr()) or 0 on end of file.
 
virtual int geterr () const
 If isok() is false, return the system error number corresponding to the error, -1 for a special error string (which you can obtain with errstr()) or 0 on end of file.
 
virtual WvString errstr () const
 
virtual WvString errstr () const
 
virtual void seterr (int _errnum)
 Set the errnum variable – we have an error.
 
void seterr (WvStringParm specialerr)
 
void seterr (WVSTRING_FORMAT_DECL)
 
void seterr (const WvErrorBase &err)
 
virtual void seterr (int _errnum)
 Set the errnum variable – we have an error.
 
void seterr (WvStringParm specialerr)
 
void seterr (WVSTRING_FORMAT_DECL)
 
void seterr (const WvErrorBase &err)
 
void seterr_both (int _errnum, WvStringParm specialerr)
 
void seterr_both (int _errnum, WVSTRING_FORMAT_DECL)
 
void seterr_both (int _errnum, WvStringParm specialerr)
 
void seterr_both (int _errnum, WVSTRING_FORMAT_DECL)
 
void noerr ()
 Reset our error state - there's no error condition anymore.
 
void noerr ()
 Reset our error state - there's no error condition anymore.
 

Static Public Member Functions

static WvString strerror (int errnum)
 A replacement for the operating system strerror() function that can map more kinds of error strings (especially in win32).
 
static WvString strerror (int errnum)
 A replacement for the operating system strerror() function that can map more kinds of error strings (especially in win32).
 

Protected Attributes

int errnum
 
WvString errstring
 

Detailed Description

A variant of WvErrorBase suitable for embedding as a member of your own object, preferably called 'err'.

It adds some extra convenience functions to remove function name redundancy, so you can say "obj.err.get()" instead of "obj.err.geterr()", for example.

Definition at line 89 of file debian/libwvstreams-dev/usr/include/wvstreams/wverror.h.

Member Function Documentation

◆ get() [1/2]

int WvError::get ( ) const
inline

◆ str() [1/2]

WvString WvError::str ( ) const
inline

◆ set() [1/8]

void WvError::set ( int  _errnum)
inline

◆ set() [2/8]

void WvError::set ( WvStringParm  specialerr)
inline

◆ set() [3/8]

void WvError::set ( WVSTRING_FORMAT_DECL  )
inline

◆ set_both() [1/2]

void WvError::set_both ( int  _errnum,
WvStringParm  specialerr 
)
inline

◆ set() [4/8]

void WvError::set ( const WvErrorBase err)
inline

◆ reset() [1/2]

void WvError::reset ( )
inline

◆ get() [2/2]

int WvError::get ( ) const
inline

Definition at line 92 of file include/wverror.h.

◆ str() [2/2]

WvString WvError::str ( ) const
inline

Definition at line 94 of file include/wverror.h.

◆ set() [5/8]

void WvError::set ( int  _errnum)
inline

Definition at line 97 of file include/wverror.h.

◆ set() [6/8]

void WvError::set ( WvStringParm  specialerr)
inline

Definition at line 99 of file include/wverror.h.

◆ set() [7/8]

void WvError::set ( WVSTRING_FORMAT_DECL  )
inline

Definition at line 101 of file include/wverror.h.

◆ set_both() [2/2]

void WvError::set_both ( int  _errnum,
WvStringParm  specialerr 
)
inline

Definition at line 103 of file include/wverror.h.

◆ set() [8/8]

void WvError::set ( const WvErrorBase err)
inline

Definition at line 105 of file include/wverror.h.

◆ reset() [2/2]

void WvError::reset ( )
inline

Definition at line 108 of file include/wverror.h.

◆ isok() [1/2]

virtual bool WvErrorBase::isok ( ) const
inlinevirtualinherited

◆ isok() [2/2]

virtual bool WvErrorBase::isok ( ) const
inlinevirtualinherited

◆ geterr() [1/2]

virtual int WvErrorBase::geterr ( ) const
inlinevirtualinherited

If isok() is false, return the system error number corresponding to the error, -1 for a special error string (which you can obtain with errstr()) or 0 on end of file.

If isok() is true, returns an undefined number.

Reimplemented in WvDBusServer, WvStreamClone, WvDBusServer, and WvStreamClone.

Definition at line 48 of file debian/libwvstreams-dev/usr/include/wvstreams/wverror.h.

Referenced by UniIniGen::commit(), UniFileSystemGen::get(), WvDBusServer::geterr(), WvStreamClone::geterr(), WvEncoderStream::isok(), UniConfDaemon::listen(), UniIniGen::refresh(), WvStream::seterr(), and WvMagicCircle::WvMagicCircle().

◆ geterr() [2/2]

virtual int WvErrorBase::geterr ( ) const
inlinevirtualinherited

If isok() is false, return the system error number corresponding to the error, -1 for a special error string (which you can obtain with errstr()) or 0 on end of file.

If isok() is true, returns an undefined number.

Reimplemented in WvDBusServer, WvStreamClone, WvDBusServer, and WvStreamClone.

Definition at line 48 of file include/wverror.h.

◆ errstr()

WvString WvErrorBase::errstr ( ) const
virtualinherited

Definition at line 127 of file wverror.cc.

◆ strerror()

WvString WvErrorBase::strerror ( int  errnum)
staticinherited

A replacement for the operating system strerror() function that can map more kinds of error strings (especially in win32).

Definition at line 91 of file wverror.cc.

References WvErrorBase::strerror().

Referenced by WvLog::perror(), WvErrorBase::strerror(), WvSSLStream::uread(), and WvSSLStream::uwrite().

◆ seterr() [1/6]

void WvErrorBase::seterr ( int  _errnum)
virtualinherited

Set the errnum variable – we have an error.

If called more than once, seterr() doesn't change the error code away from the previous one. That way, we remember the original cause of our problems.

Subclasses may want to override seterr(int) to shut themselves down (eg. WvStream::close()) when an error condition is set.

Note that seterr(WvString) will call seterr(-1).

Reimplemented in WvStream, and WvStream.

Definition at line 144 of file wverror.cc.

Referenced by WvTCPListener::accept(), WvUnixListener::accept(), WvDSAKey::getpem(), WvGlob::set(), WvStream::seterr(), WvMagicCircle::WvMagicCircle(), WvPam::WvPam(), WvPam::WvPam(), WvShmZone::WvShmZone(), and WvTCPListener::WvTCPListener().

◆ seterr() [2/6]

void WvErrorBase::seterr ( WvStringParm  specialerr)
inherited

Definition at line 159 of file wverror.cc.

◆ seterr() [3/6]

void WvErrorBase::seterr ( WVSTRING_FORMAT_DECL  )
inlineinherited

◆ seterr() [4/6]

void WvErrorBase::seterr ( const WvErrorBase err)
inherited

Definition at line 170 of file wverror.cc.

◆ seterr() [5/6]

virtual void WvErrorBase::seterr ( int  _errnum)
virtualinherited

Set the errnum variable – we have an error.

If called more than once, seterr() doesn't change the error code away from the previous one. That way, we remember the original cause of our problems.

Subclasses may want to override seterr(int) to shut themselves down (eg. WvStream::close()) when an error condition is set.

Note that seterr(WvString) will call seterr(-1).

Reimplemented in WvStream, and WvStream.

◆ seterr() [6/6]

void WvErrorBase::seterr ( WVSTRING_FORMAT_DECL  )
inlineinherited

Definition at line 70 of file include/wverror.h.

◆ seterr_both() [1/3]

void WvErrorBase::seterr_both ( int  _errnum,
WvStringParm  specialerr 
)
inherited

Definition at line 179 of file wverror.cc.

◆ seterr_both() [2/3]

void WvErrorBase::seterr_both ( int  _errnum,
WVSTRING_FORMAT_DECL   
)
inlineinherited

◆ seterr_both() [3/3]

void WvErrorBase::seterr_both ( int  _errnum,
WVSTRING_FORMAT_DECL   
)
inlineinherited

Definition at line 73 of file include/wverror.h.

◆ noerr() [1/2]

void WvErrorBase::noerr ( )
inlineinherited

Reset our error state - there's no error condition anymore.

Definition at line 78 of file debian/libwvstreams-dev/usr/include/wvstreams/wverror.h.

◆ noerr() [2/2]

void WvErrorBase::noerr ( )
inlineinherited

Reset our error state - there's no error condition anymore.

Definition at line 78 of file include/wverror.h.

Member Data Documentation

◆ errnum

int WvErrorBase::errnum
protectedinherited

◆ errstring

WvString WvErrorBase::errstring
protectedinherited

The documentation for this class was generated from the following files: