RTI Connext Java API Version 7.1.0

Types of return codes. More...

Classes

class  RETCODE_ALREADY_DELETED
 The object target of this operation has already been deleted. More...
 
class  RETCODE_BAD_PARAMETER
 Illegal parameter value. More...
 
class  RETCODE_ERROR
 Generic, unspecified error. More...
 
class  RETCODE_ILLEGAL_OPERATION
 The operation was called under improper circumstances. More...
 
class  RETCODE_IMMUTABLE_POLICY
 Application attempted to modify an immutable QoS policy. More...
 
class  RETCODE_INCONSISTENT_POLICY
 Application specified a set of QoS policies that are not consistent with each other. More...
 
class  RETCODE_NO_DATA
 Indicates a transient situation where the operation did not return any data but there is no inherent error. More...
 
class  RETCODE_NOT_ALLOWED_BY_SECURITY
 An operation on the DDS API that fails because the security plugins do not allow it. More...
 
class  RETCODE_NOT_ENABLED
 Operation invoked on a com.rti.dds.infrastructure.Entity that is not yet enabled. More...
 
class  RETCODE_OUT_OF_RESOURCES
 RTI Connext ran out of the resources needed to complete the operation. More...
 
class  RETCODE_PRECONDITION_NOT_MET
 A pre-condition for the operation was not met. More...
 
class  RETCODE_TIMEOUT
 The operation timed out. More...
 
class  RETCODE_UNSUPPORTED
 Unsupported operation. Only returned by operations that are unsupported. More...
 

Detailed Description

Types of return codes.

Standard Return Codes

Any void operation that documents that it may throw an exception of type may throw exactly com.rti.dds.infrastructure.RETCODE_ERROR or com.rti.dds.infrastructure.RETCODE_ILLEGAL_OPERATION. Any such operation that takes one or more input parameters may additionally throw the subclass com.rti.dds.infrastructure.RETCODE_BAD_PARAMETER. Any operation on an object created from any of the factories may additionally throw the subclass com.rti.dds.infrastructure.RETCODE_ALREADY_DELETED. Any operation that is stated as optional may additionally throw the subclass com.rti.dds.infrastructure.RETCODE_UNSUPPORTED. com.rti.dds.infrastructure.RETCODE_OK com.rti.dds.infrastructure.RETCODE_ERROR or com.rti.dds.infrastructure.RETCODE_ILLEGAL_OPERATION. Any operation that takes one or more input parameters may additionally return com.rti.dds.infrastructure.RETCODE_BAD_PARAMETER. Any operation on an object created from any of the factories may additionally return com.rti.dds.infrastructure.RETCODE_ALREADY_DELETED. Any operation that is stated as optional may additionally return com.rti.dds.infrastructure.RETCODE_UNSUPPORTED.

Thus, the standard return codes are:

Operations that may throw any other exception type will state so explicitly.