Return Codes

Types of return codes. 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 }
	Type for return codes. More...

Detailed Description

Types of return codes.

Standard Return Codes

Any operation with return type DDS_ReturnCode_t may return DDS_RETCODE_OK DDS_RETCODE_ERROR or DDS_RETCODE_ILLEGAL_OPERATION. Any operation that takes one or more input parameters may additionally return DDS_RETCODE_BAD_PARAMETER. Any operation on an object created from any of the factories may additionally return DDS_RETCODE_ALREADY_DELETED. Any operation that is stated as optional may additionally return DDS_RETCODE_UNSUPPORTED.

Thus, the standard return codes are:

• DDS_RETCODE_ERROR
• DDS_RETCODE_ILLEGAL_OPERATION
• DDS_RETCODE_ALREADY_DELETED
• DDS_RETCODE_BAD_PARAMETER
• DDS_RETCODE_UNSUPPORTED

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

Enumeration Type Documentation

enum DDS_ReturnCode_t

Type for return codes.

Errors are modeled as operation return codes of this type.

Enumerator:

DDS_RETCODE_OK	Successful return.
DDS_RETCODE_ERROR	Generic, unspecified error.
DDS_RETCODE_UNSUPPORTED	Unsupported operation. Can only returned by operations that are unsupported.
DDS_RETCODE_BAD_PARAMETER	Illegal parameter value. The value of the parameter that is passed in has llegal value. Things that fall into this category include NULL parameters and parameter values that are out of range.
DDS_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.
DDS_RETCODE_OUT_OF_RESOURCES	RTI Connext ran out of the resources needed to complete the operation.
DDS_RETCODE_NOT_ENABLED	Operation invoked on a DDSEntity that is not yet enabled.
DDS_RETCODE_IMMUTABLE_POLICY	Application attempted to modify an immutable QoS policy.
DDS_RETCODE_INCONSISTENT_POLICY	Application specified a set of QoS policies that are not consistent with each other.
DDS_RETCODE_ALREADY_DELETED	The object target of this operation has already been deleted.
DDS_RETCODE_TIMEOUT	The operation timed out.
DDS_RETCODE_NO_DATA	Indicates a transient situation where the operation did not return any data but there is no inherent error.
DDS_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_PRECONDITION_NOT_MET, except that there is no precondition that could be changed to make the operation succeed.