ROException

Overview

ROException is the base class for all exception types related to Remoting SDK. This includes exceptions thrown from the RO SDK code indicating some error condition and exceptions defined in your RODL Library. The base exception type provides special support for propagating exceptions back from servers. Any server exceptions that are unknown on the client or do not descend from ROException will be represented using a special descendant of ROException, ROServerException .

Location

 

exceptionName

Return the exception name to be used to construct the class instance as NSException descendant. See NSException documentation for more details.

+ (NSString *) exceptionName

exceptionWithMessage:

Constructs the excetion instance with the given text message (corresponds to reason of NSException).

+ (ROException *) exceptionWithMessage:(NSString *)aExceptionMessage

Parameters:

  • aExceptionMessage: A text string decribing the exception

fromServer  assign

This flag is used to distinguish server side exceptions from client side ones. Set to YES for server side exceptions.

@property (assign) BOOL fromServer

initWithMessage:

initializes a new ROException with the given error message.

- (id) initWithMessage:(NSString *)aExceptionMessage

Parameters:

  • aExceptionMessage: A text string decribing the exception

initWithMessage:fromServer:

Initializes a new ROException with the given error message and optionally marks the exception as having been received from a server by setting the fromServer property.

- (id) initWithMessage:(NSString *)aExceptionMessage fromServer:(BOOL)aFromServer

Parameters:

  • aExceptionMessage: A text string decribing the exception
  • aFromServer: Set to YES for server side exceptions.

serverStackTrace  copy

Used to store the stack trace of server exception. The availability of this information depends on the server platform.

@property (copy) NSString *serverStackTrace

 

fromServer  assign

This flag is used to distinguish server side exceptions from client side ones. Set to YES for server side exceptions.

@property (assign) BOOL fromServer

serverStackTrace  copy

Used to store the stack trace of server exception. The availability of this information depends on the server platform.

@property (copy) NSString *serverStackTrace

 

exceptionName

Return the exception name to be used to construct the class instance as NSException descendant. See NSException documentation for more details.

+ (NSString *) exceptionName

exceptionWithMessage:

Constructs the excetion instance with the given text message (corresponds to reason of NSException).

+ (ROException *) exceptionWithMessage:(NSString *)aExceptionMessage

Parameters:

  • aExceptionMessage: A text string decribing the exception

 

initWithMessage:

initializes a new ROException with the given error message.

- (id) initWithMessage:(NSString *)aExceptionMessage

Parameters:

  • aExceptionMessage: A text string decribing the exception

initWithMessage:fromServer:

Initializes a new ROException with the given error message and optionally marks the exception as having been received from a server by setting the fromServer property.

- (id) initWithMessage:(NSString *)aExceptionMessage fromServer:(BOOL)aFromServer

Parameters:

  • aExceptionMessage: A text string decribing the exception
  • aFromServer: Set to YES for server side exceptions.

Descendants

See Also