ROTCPDispatchErrorException
Overview
This eception is thrown by ROTCPClientChannel class when it is unable to dispatch a message. As a rule this inidicates a network problem or unavailable server.
Location
- Reference: ROTCPClientChannel.h
- Namespace: RemObjectsSDK
- Ancestry: NSException | ROException | ROClientChannelException | RODispatchErrorException | ROTCPDispatchErrorException
commStage assign
This integer number shows the communication stage that has failed. This information is valuable for the support team if you consider issuing a support request.
@property (assign) int commStage
exceptionName (declared in ROException)
Return the exception name to be used to construct the class instance as NSException descendant. See NSException documentation for more details.
+ (NSString *) exceptionName
exceptionWithInnerError: (declared in RODispatchErrorException)
Creates an exception object with the default error message and assigns the internal error object to it.
+ (RODispatchErrorException *) exceptionWithInnerError:(NSError *)aError
Parameters:
- aError: The error object returned by the underlying communication subsystem
exceptionWithMessage: (declared in ROException)
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
exceptionWithMessage:atStage:
Creates an exception instance with a error message and communication stage that has failed.
+ (ROTCPDispatchErrorException *) exceptionWithMessage:(NSString *)aExceptionMessage atStage:(int)aStage
Parameters:
- aExceptionMessage: A text message describing the error condition
- aStage: The communication stage number that has failed
exceptionWithMessage:innerError: (declared in RODispatchErrorException)
Creates an exception object with a custom error message and assigns the internal error object to it.
+ (RODispatchErrorException *) exceptionWithMessage:(NSString *)aExceptionMessage innerError:(NSError *)aError
Parameters:
- aExceptionMessage: Text message describing the error condition
- aError: The error object returned by the underlying communication subsystem
exceptionWithMessage:innerError:atStage:
Creates an exception instance with a error message, communication stage that has failed and the error object returned by underlying communication subsystem.
+ (ROTCPDispatchErrorException *) exceptionWithMessage:(NSString *)aExceptionMessage innerError:(NSError *)aError atStage:(int)aStage
Parameters:
- aExceptionMessage: A text message describing the error condition
- aError: Error object returned by underlying communication subsystem
- aStage: The communication stage number that has failed
fromServer assign (declared in ROException)
This flag is used to distinguish server side exceptions from client side ones. Set to YES for server side exceptions.
@property (assign) BOOL fromServer
initWithInnerError: (declared in RODispatchErrorException)
Initializes the exception object with the default error message and assigns the internal error object to it.
- (id) initWithInnerError:(NSError *)aError
Parameters:
- aError: The error object returned by the underlying communication subsystem
initWithMessage: (declared in ROException)
initializes a new ROException with the given error message.
- (id) initWithMessage:(NSString *)aExceptionMessage
Parameters:
- aExceptionMessage: A text string decribing the exception
initWithMessage:atStage:
Initializes the exception instance with a error message and communication stage that has failed.
- (id) initWithMessage:(NSString *)aExceptionMessage atStage:(int)aStage
Parameters:
- aExceptionMessage: A text message describing the error condition
- aStage: The communication stage number that has failed
initWithMessage:fromServer: (declared in ROException)
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.
initWithMessage:innerError: (declared in RODispatchErrorException)
Initializes the exception object with a custom error message and assigns the internal error object to it.
- (id) initWithMessage:(NSString *)aExceptionMessage innerError:(NSError *)aError
Parameters:
- aExceptionMessage: Text message describing the error condition
- aError: The error object returned by the underlying communication subsystem
initWithMessage:innerError:atStage:
Initializes the exception instance with a error message, communication stage that has failed and the error object returned by underlying communication subsystem.
- (id) initWithMessage:(NSString *)aExceptionMessage innerError:(NSError *)aError atStage:(int)aStage
Parameters:
- aExceptionMessage: A text message describing the error condition
- aError: Error object returned by underlying communication subsystem
- aStage: The communication stage number that has failed
innerError retain (declared in RODispatchErrorException)
@property (retain) NSError *innerError
serverStackTrace copy (declared in ROException)
Used to store the stack trace of server exception. The availability of this information depends on the server platform.
@property (copy) NSString *serverStackTrace
commStage assign
This integer number shows the communication stage that has failed. This information is valuable for the support team if you consider issuing a support request.
@property (assign) int commStage
fromServer assign (declared in ROException)
This flag is used to distinguish server side exceptions from client side ones. Set to YES for server side exceptions.
@property (assign) BOOL fromServer
innerError retain (declared in RODispatchErrorException)
@property (retain) NSError *innerError
serverStackTrace copy (declared in ROException)
Used to store the stack trace of server exception. The availability of this information depends on the server platform.
@property (copy) NSString *serverStackTrace
exceptionName (declared in ROException)
Return the exception name to be used to construct the class instance as NSException descendant. See NSException documentation for more details.
+ (NSString *) exceptionName
exceptionWithInnerError: (declared in RODispatchErrorException)
Creates an exception object with the default error message and assigns the internal error object to it.
+ (RODispatchErrorException *) exceptionWithInnerError:(NSError *)aError
Parameters:
- aError: The error object returned by the underlying communication subsystem
exceptionWithMessage: (declared in ROException)
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
exceptionWithMessage:atStage:
Creates an exception instance with a error message and communication stage that has failed.
+ (ROTCPDispatchErrorException *) exceptionWithMessage:(NSString *)aExceptionMessage atStage:(int)aStage
Parameters:
- aExceptionMessage: A text message describing the error condition
- aStage: The communication stage number that has failed
exceptionWithMessage:innerError: (declared in RODispatchErrorException)
Creates an exception object with a custom error message and assigns the internal error object to it.
+ (RODispatchErrorException *) exceptionWithMessage:(NSString *)aExceptionMessage innerError:(NSError *)aError
Parameters:
- aExceptionMessage: Text message describing the error condition
- aError: The error object returned by the underlying communication subsystem
exceptionWithMessage:innerError:atStage:
Creates an exception instance with a error message, communication stage that has failed and the error object returned by underlying communication subsystem.
+ (ROTCPDispatchErrorException *) exceptionWithMessage:(NSString *)aExceptionMessage innerError:(NSError *)aError atStage:(int)aStage
Parameters:
- aExceptionMessage: A text message describing the error condition
- aError: Error object returned by underlying communication subsystem
- aStage: The communication stage number that has failed
initWithInnerError: (declared in RODispatchErrorException)
Initializes the exception object with the default error message and assigns the internal error object to it.
- (id) initWithInnerError:(NSError *)aError
Parameters:
- aError: The error object returned by the underlying communication subsystem
initWithMessage: (declared in ROException)
initializes a new ROException with the given error message.
- (id) initWithMessage:(NSString *)aExceptionMessage
Parameters:
- aExceptionMessage: A text string decribing the exception
initWithMessage:atStage:
Initializes the exception instance with a error message and communication stage that has failed.
- (id) initWithMessage:(NSString *)aExceptionMessage atStage:(int)aStage
Parameters:
- aExceptionMessage: A text message describing the error condition
- aStage: The communication stage number that has failed
initWithMessage:fromServer: (declared in ROException)
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.
initWithMessage:innerError: (declared in RODispatchErrorException)
Initializes the exception object with a custom error message and assigns the internal error object to it.
- (id) initWithMessage:(NSString *)aExceptionMessage innerError:(NSError *)aError
Parameters:
- aExceptionMessage: Text message describing the error condition
- aError: The error object returned by the underlying communication subsystem
initWithMessage:innerError:atStage:
Initializes the exception instance with a error message, communication stage that has failed and the error object returned by underlying communication subsystem.
- (id) initWithMessage:(NSString *)aExceptionMessage innerError:(NSError *)aError atStage:(int)aStage
Parameters:
- aExceptionMessage: A text message describing the error condition
- aError: Error object returned by underlying communication subsystem
- aStage: The communication stage number that has failed