ROBinMessageVersionException
Overview
This exception is thrown by ROBinMessage when incoming message's version (as specified in the dedicated binary message field) is not supported by the current RO SDK version.
Location
- Reference: ROBinMessage.h
- Namespace: RemObjectsSDK
- Ancestry: NSException | ROException | ROMessageException | ROInvalidBinMessageException | ROBinMessageVersionException
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
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
exceptionWithRemoteVersion:
Creates an exception instance
+ (ROBinMessageVersionException *) exceptionWithRemoteVersion:(long)aVersion
Parameters:
- aVersion: Binary message version received from the remote
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
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: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.
initWithRemoteVersion:
Initializes the exception instance
- (id) initWithRemoteVersion:(long)aVersion
Parameters:
- aVersion: Binary message version received from the remote
maximumSupportedVersion
Maximum binary message version supported by the current RO SDK code.
@property (readonly) long maximumSupportedVersion
minimumSupportedVersion
Minimum binary message version supported by the current RO SDK code.
@property (readonly) long minimumSupportedVersion
remoteMessageVersion assign
Binary message version received from the remote.
@property (assign) long remoteMessageVersion
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
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
maximumSupportedVersion
Maximum binary message version supported by the current RO SDK code.
@property (readonly) long maximumSupportedVersion
minimumSupportedVersion
Minimum binary message version supported by the current RO SDK code.
@property (readonly) long minimumSupportedVersion
remoteMessageVersion assign
Binary message version received from the remote.
@property (assign) long remoteMessageVersion
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
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
exceptionWithRemoteVersion:
Creates an exception instance
+ (ROBinMessageVersionException *) exceptionWithRemoteVersion:(long)aVersion
Parameters:
- aVersion: Binary message version received from the remote
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: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.
initWithRemoteVersion:
Initializes the exception instance
- (id) initWithRemoteVersion:(long)aVersion
Parameters:
- aVersion: Binary message version received from the remote