xvr2::Net::SocketOptionParamFailure Class Reference

#include <xvr2/Net/SocketExceptions.h>

Inheritance diagram for xvr2::Net::SocketOptionParamFailure:

[legend]

List of all members.

---

Detailed Description

Exception thrown after a call to Socket::setsockopt(int level, int optname, const void *optval, socklen_t optlen) fails.

Most commonly when this exception is thrown an internal runtime X-VR2 library call to the OS-specific call to setsockopt has failed, this can be due to a portability problem or a library BUG.

Definition at line 53 of file SocketExceptions.h.

Public Member Functions
	SocketOptionParamFailure ()
	Default constructor.
	SocketOptionParamFailure (OSErrorCodeT x_errno)
	This constructor initializes the internal os_errval variable only.
	SocketOptionParamFailure (OSErrorCodeT x_errno, int __optname)
	This constructor initializes the internal os_errval and optionname variable.
int	optionNameVal ()
String	optionName ()
OSErrorCodeT	osErrorCode ()
	Returns the error code's value at the time the exception was thrown.
String	osErrorMessage ()
	Returns an String describing a textual representation of the error condition thrown.
int	code ()
	Deprecated method, please don't use.
virtual String	message ()
	Deprecated method, please don't use.
std::string	toString ()
	Displays the description of the exception.
const char *	backtrace ()
virtual const char *	getClassName ()
	Returns the name of the current class.
Static Public Member Functions
static void	enable ()
static void	disable ()
static void	debugmsg (Object *obj, const char *msg, int linenumber=__LINE__, const char *srcfile=__FILE__)
	Will print a debug message to the screen.
static void	debugmsgln (Object *obj, const char *msg, int linenumber=__LINE__, const char *srcfile=__FILE__)
Protected Member Functions
virtual void	dumpTrace ()
Protected Attributes
int	_optname
std::string	description
	Stores the exception's description as a string.
std::string	__cls_name
Friends
std::ostream &	operator<< (std::ostream &stream, const Object &s)

---

Constructor & Destructor Documentation

xvr2::Net::SocketOptionParamFailure::SocketOptionParamFailure

(

)

Default constructor.

xvr2::Net::SocketOptionParamFailure::SocketOptionParamFailure

(

OSErrorCodeT

x_errno

)

This constructor initializes the internal os_errval variable only.

xvr2::Net::SocketOptionParamFailure::SocketOptionParamFailure	(	OSErrorCodeT	x_errno,
		int	__optname
	)

This constructor initializes the internal os_errval and optionname variable.

Since this constructor properly initilizes the os_errval and the affected optionname variable you are encouraged to always use it.

---

Member Function Documentation

int xvr2::Net::SocketOptionParamFailure::optionNameVal

(

)

String xvr2::Net::SocketOptionParamFailure::optionName

(

)

OSErrorCodeT xvr2::SystemException::osErrorCode

(

)

[inherited]

Returns the error code's value at the time the exception was thrown.

String xvr2::SystemException::osErrorMessage

(

)

[inherited]

Returns an String describing a textual representation of the error condition thrown.

int xvr2::SystemException::code

(

)

[inherited]

Deprecated method, please don't use.

Deprecated:

This method will be removed in X-VR2 version 0.8.3

virtual String xvr2::SystemException::message

(

)

[virtual, inherited]

Deprecated method, please don't use.

Deprecated:

This method will be removed in X-VR2 version 0.8.3

std::string xvr2::Exception::toString

(

)

[virtual, inherited]

Displays the description of the exception.

Reimplemented from xvr2::Object.

virtual void xvr2::ExceptionTracer::dumpTrace

(

)

[protected, virtual, inherited]

static void xvr2::ExceptionTracer::enable

(

)

[static, inherited]

static void xvr2::ExceptionTracer::disable

(

)

[static, inherited]

const char* xvr2::ExceptionTracer::backtrace

(

)

[inherited]

virtual const char* xvr2::Object::getClassName

(

)

[virtual, inherited]

Returns the name of the current class.

static void xvr2::Object::debugmsg	(	Object *	obj,
		const char *	msg,
		int	linenumber = __LINE__,
		const char *	srcfile = __FILE__
	)			[static, inherited]

Will print a debug message to the screen.

static void xvr2::Object::debugmsgln	(	Object *	obj,
		const char *	msg,
		int	linenumber = __LINE__,
		const char *	srcfile = __FILE__
	)			[static, inherited]

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	stream,
		const Object &	s
	)			[friend, inherited]

---

Member Data Documentation

int xvr2::Net::SocketOptionParamFailure::_optname [protected]

Definition at line 55 of file SocketExceptions.h.

std::string xvr2::Exception::description [protected, inherited]

Stores the exception's description as a string.

Definition at line 29 of file CoreExceptions.h.

std::string xvr2::Object::__cls_name [protected, inherited]

Definition at line 30 of file Object.h.

---

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

• /home/coredumped/X-VR2_Trunk/Net/xvr2/SocketExceptions.h