#include <usServiceException.h>

Inheritance diagram for us::ServiceException:

Collaboration diagram for us::ServiceException:

Public Types
enum	Type { UNSPECIFIED , UNREGISTERED , FACTORY_ERROR , FACTORY_EXCEPTION , REMOTE , FACTORY_RECURSION }

Public Member Functions
	ServiceException (const std::string &msg, const Type &type=UNSPECIFIED)
	Creates a `ServiceException` with the specified message, type and exception cause. More...

	ServiceException (const ServiceException &o)
	Copy constructor. More...

ServiceException &	operator= (const ServiceException &o)
	Copy assignment operator. More...

	~ServiceException () override throw ()

Type	GetType () const
	Returns the type for this exception or `UNSPECIFIED` if the type was unspecified or unknown. More...

Detailed Description

A service exception used to indicate that a service problem occurred.

A ServiceException object is created by the framework or to denote an exception condition in the service. An enum type is used to identify the exception type for future extendability.

This exception conforms to the general purpose exception chaining mechanism.

Definition at line 37 of file usServiceException.h.

Member Enumeration Documentation

◆ Type

enum us::ServiceException::Type

Enumerator
UNSPECIFIED	The exception type is unspecified.
UNREGISTERED	The service has been unregistered.
FACTORY_ERROR	The service factory produced an invalid service object.
FACTORY_EXCEPTION	The service factory threw an exception.
REMOTE	An error occurred invoking a remote service.
FACTORY_RECURSION	The service factory resulted in a recursive call to itself for the requesting module.

Definition at line 41 of file usServiceException.h.

Constructor & Destructor Documentation

◆ ServiceException() [1/2]

us::ServiceException::ServiceException	(	const std::string &	msg,
		const Type &	type = `UNSPECIFIED`
	)

Creates a ServiceException with the specified message, type and exception cause.

Parameters

[in]	msg	The associated message.
[in]	type	The type for this exception.

◆ ServiceException() [2/2]

us::ServiceException::ServiceException ( const ServiceException & o )

Copy constructor.

◆ ~ServiceException()

us::ServiceException::~ServiceException	(	)
throw	(
	)

inlineoverride

Definition at line 84 of file usServiceException.h.

Member Function Documentation

◆ GetType()

Type us::ServiceException::GetType ( ) const

Returns the type for this exception or UNSPECIFIED if the type was unspecified or unknown.

Returns: The type of this exception.

◆ operator=()

ServiceException& us::ServiceException::operator= ( const ServiceException & o )

Copy assignment operator.

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

usServiceException.h

Public Types

Public Member Functions