exception.h File Reference

VSM exceptions definition. More...

#include <ugcs/vsm/defs.h>
#include <stdarg.h>
#include <string>

Go to the source code of this file.

Classes
class	ugcs::vsm::Exception
	Base class for all VSM exceptions. More...
struct	ugcs::vsm::Exception::Va_list_overload
	Dummy structure to explicitly indicate the constructor overload for va_list type argument. More...
struct	ugcs::vsm::Exception::Va_args_overload
	Dummy structure to explicitly indicate the constructor overload for variable arguments (i.e. More...
class	ugcs::vsm::Param_exception< Dummy, TParam >
	Exception class with one parameter. More...
class	ugcs::vsm::Derived_exception< Base_exception, Dummy >
	Helper class for defining derived exceptions. More...

Namespaces
	ugcs
	UGCS root namespace.
	ugcs::vsm
	All VSM SDK functionality resides in this namespace.

Macros
#define	VSM_EXCEPTION(__exc_class, __msg,...)
	Throw VSM exception instance. More...
#define	VSM_PARAM_EXCEPTION(__exc_class, __param, __msg,...)
	Throw VSM exception instance with parameter. More...
#define	VSM_SYS_EXCEPTION(__msg,...)
	Throw VSM system exception - i.e. More...
#define	VSM_DEFINE_EXCEPTION(__exc_class,...)
	Define custom exception type. More...
#define	VSM_DEFINE_DERIVED_EXCEPTION(__base_class, __exc_class)
	Define custom derived exception. More...

Functions
	ugcs::vsm::VSM_DEFINE_EXCEPTION (Debug_assert_exception)
	Exception to throw when debugging assertion fires. More...
	ugcs::vsm::VSM_DEFINE_EXCEPTION (Nullptr_exception)
	Indicates that some object is not longer exists while its service is invoked. More...
	ugcs::vsm::VSM_DEFINE_EXCEPTION (Invalid_param_exception)
	Indicates that some invalid parameter was passed to SDK API call. More...
	ugcs::vsm::VSM_DEFINE_EXCEPTION (Invalid_op_exception)
	Indicates that the operation is invalid in current state. More...
	ugcs::vsm::VSM_DEFINE_EXCEPTION (Internal_error_exception)
	Some unexpected internal error occurred. More...
	ugcs::vsm::VSM_DEFINE_EXCEPTION (System_exception)
	Exception for system call failure. More...

Detailed Description

VSM exceptions definition.

Macro Definition Documentation

#define VSM_DEFINE_DERIVED_EXCEPTION	(		__base_class,
			__exc_class
	)

Value:

 \
    struct __exc_class ## _dummy_struct {}; \ \
    typedef ugcs::vsm::Derived_exception<__base_class, __exc_class ## _dummy_struct> __exc_class

Define custom derived exception.

Parameters

__base_class	Type of base exception class.
__exc_class	Name for new exception type.

#define VSM_DEFINE_EXCEPTION	(		__exc_class,
			...
	)

Value:

struct __exc_class ## _dummy_struct {}; \
    typedef ugcs::vsm::Param_exception<__exc_class ## _dummy_struct, ## __VA_ARGS__> __exc_class

Define custom exception type.

Parameters

__exc_class	Name for new exception type.
...	Parameter type can be specified as second argument.

See Also

Param_exception

#define VSM_EXCEPTION	(		__exc_class,
			__msg,
			...
	)

Value:

/* Dummy format argument is added to avoid GCC 4.8.1 bug related to printf attribute. */ \
    throw __exc_class(__exc_class::Va_args_overload(), "%s" __msg, "", ## __VA_ARGS__)

Throw VSM exception instance.

Parameters

__exc_class	Exception class name.
__msg	Formatted description message.
...	Message format parameters.

Examples:

hello_world_vsm.cpp.

#define VSM_PARAM_EXCEPTION	(		__exc_class,
			__param,
			__msg,
			...
	)

Value:

/* Dummy format argument is added to avoid GCC 4.8.1 bug related to printf attribute. */ \
    throw __exc_class(__exc_class::Va_args_overload(), __param, "%s" __msg, "", ## __VA_ARGS__)

Throw VSM exception instance with parameter.

Parameters

__exc_class	Exception class name.
__param	Parameter value.
__msg	Formatted description message.
...	Message format parameters.

#define VSM_SYS_EXCEPTION	(		__msg,
			...
	)

Value:

do { \
    std::string sys_msg = ugcs::vsm::Log::Get_system_error(); \
    VSM_EXCEPTION(ugcs::vsm::System_exception, __msg ": %s", ## __VA_ARGS__, sys_msg.c_str()); \
} while (false)

Throw VSM system exception - i.e.

the one caused by system call failure. Special handling is required because system error code might be overwritten by exception allocation functions, so it must be taken as soon as possible.

Parameters

__msg	Descriptive message of the failure context.
...	Message format parameters.