RTI Connext .Net APIs  Version 5.3.1

Types of return codes. More...

Classes

class  DDS::Exception
 Superclass of all exceptions thrown by the RTI Connext 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 Connext 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...
 
class  DDS::Retcode_NotAllowedBySec
 An operation on the DDS API that fails because the security plugins do not allow it. More...
 

Enumerations

enum  DDS::ReturnCode_t : UINT32 {
  DDS::ReturnCode_t::RETCODE_OK,
  DDS::ReturnCode_t::RETCODE_ERROR,
  DDS::ReturnCode_t::RETCODE_UNSUPPORTED,
  DDS::ReturnCode_t::RETCODE_BAD_PARAMETER,
  DDS::ReturnCode_t::RETCODE_PRECONDITION_NOT_MET,
  DDS::ReturnCode_t::RETCODE_OUT_OF_RESOURCES,
  DDS::ReturnCode_t::RETCODE_NOT_ENABLED,
  DDS::ReturnCode_t::RETCODE_IMMUTABLE_POLICY,
  DDS::ReturnCode_t::RETCODE_INCONSISTENT_POLICY,
  DDS::ReturnCode_t::RETCODE_ALREADY_DELETED,
  DDS::ReturnCode_t::RETCODE_TIMEOUT,
  DDS::ReturnCode_t::RETCODE_NO_DATA,
  DDS::ReturnCode_t::RETCODE_ILLEGAL_OPERATION,
  DDS::ReturnCode_t::RETCODE_NOT_ALLOWED_BY_SEC
}
 Superclass of all exceptions thrown by the RTI Connext 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:

Enumeration Type Documentation

◆ ReturnCode_t

enum DDS::ReturnCode_t : UINT32
strong

Superclass of all exceptions thrown by the RTI Connext 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 fall into this category include 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 Connext 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.

RETCODE_NOT_ALLOWED_BY_SEC 

An operation on the DDS API that fails because the security plugins do not allow it.

An operation on the DDS API that fails because the security plugins do not allow it.


RTI Connext .Net APIs Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc