Return Codes
[Infrastructure Module]

Types of return codes. More...

Classes
class	DDS::Exception
	Superclass of all exceptions thrown by the RTI Data Distribution Service API. More...
class	DDS::Retcode_Error
	Generic, unspecified error. More...
class	DDS::Retcode_Unsupported
	Unsupported operation. Can only returned by operations that are unsupported. More...
class	DDS::Retcode_BadParameter
	Illegal parameter value. More...
class	DDS::Retcode_PreconditionNotMet
	A pre-condition for the operation was not met. More...
class	DDS::Retcode_OutOfResources
	RTI Data Distribution Service ran out of the resources needed to complete the operation. More...
class	DDS::Retcode_NotEnabled
	Operation invoked on a DDS::Entity that is not yet enabled. More...
class	DDS::Retcode_ImmutablePolicy
	Application attempted to modify an immutable QoS policy. More...
class	DDS::Retcode_InconsistentPolicy
	Application specified a set of QoS policies that are not consistent with each other. More...
class	DDS::Retcode_AlreadyDeleted
	The object target of this operation has already been deleted. More...
class	DDS::Retcode_Timeout
	The operation timed out. More...
class	DDS::Retcode_NoData
	Indicates a transient situation where the operation did not return any data but there is no inherent error. More...
class	DDS::Retcode_IllegalOperation
	The operation was called under improper circumstances. More...
Enumerations
enum	DDS::ReturnCode_t {   DDS::RETCODE_OK,   DDS::RETCODE_ERROR,   DDS::RETCODE_UNSUPPORTED,   DDS::RETCODE_BAD_PARAMETER,   DDS::RETCODE_PRECONDITION_NOT_MET,   DDS::RETCODE_OUT_OF_RESOURCES,   DDS::RETCODE_NOT_ENABLED,   DDS::RETCODE_IMMUTABLE_POLICY,   DDS::RETCODE_INCONSISTENT_POLICY,   DDS::RETCODE_ALREADY_DELETED,   DDS::RETCODE_TIMEOUT,   DDS::RETCODE_NO_DATA,   DDS::RETCODE_ILLEGAL_OPERATION }
	Superclass of all exceptions thrown by the RTI Data Distribution Service API. More...

---

Detailed Description

Types of return codes.

Standard Return Codes

Any operation with return type DDS::Exception may return DDS::Exception::RETCODE_OK DDS::Retcode_Error or DDS::Retcode_IllegalOperation. Any operation that takes one or more input parameters may additionally return DDS::Retcode_BadParameter. Any operation on an object created from any of the factories may additionally return DDS::Retcode_AlreadyDeleted. Any operation that is stated as optional may additionally return DDS::Retcode_Unsupported.

Thus, the standard return codes are:

• DDS::Retcode_Error
• DDS::Retcode_IllegalOperation
• DDS::Retcode_AlreadyDeleted
• DDS::Retcode_BadParameter
• DDS::Retcode_Unsupported

Operations that may return any of the additional return codes will state so explicitly.

---

Enumeration Type Documentation

enum DDS::ReturnCode_t

Superclass of all exceptions thrown by the RTI Data Distribution Service API.

Applications are not expected to throw or extend this type, but to handle exceptions of its more-specific subclasses.

Enumerator:

RETCODE_OK	Successful return.
RETCODE_ERROR	Generic, unspecified error.
RETCODE_UNSUPPORTED	Unsupported operation. Can only returned by operations that are unsupported.
RETCODE_BAD_PARAMETER	Illegal parameter value. The value of the parameter that is passed in has llegal value. Things that falls into this category includes null parameters and parameter values that are out of range.
RETCODE_PRECONDITION_NOT_MET	A pre-condition for the operation was not met. The system is not in the expected state when the function is called, or the parameter itself is not in the expected state when the function is called.
RETCODE_OUT_OF_RESOURCES	RTI Data Distribution Service ran out of the resources needed to complete the operation.
RETCODE_NOT_ENABLED	Operation invoked on a DDS::Entity that is not yet enabled.
RETCODE_IMMUTABLE_POLICY	Application attempted to modify an immutable QoS policy.
RETCODE_INCONSISTENT_POLICY	Application specified a set of QoS policies that are not consistent with each other.
RETCODE_ALREADY_DELETED	The object target of this operation has already been deleted.
RETCODE_TIMEOUT	The operation timed out.
RETCODE_NO_DATA	Indicates a transient situation where the operation did not return any data but there is no inherent error.
RETCODE_ILLEGAL_OPERATION	The operation was called under improper circumstances. An operation was invoked on an inappropriate object or at an inappropriate time. This return code is similar to DDS::Retcode_PreconditionNotMet, except that there is no precondition that could be changed to make the operation succeed.