SessionNotFoundException

Overview

SessionNotFoundException, a special exception class shared between all three editions of Remoting SDK, is used to indicate when a remote call failed because no session was found - typically meaning that user login is required.

ROClientChannel will automatically catch exceptions of this class and call a dedicated delegate method (if provided) to allow the client to perform the necessary login procedure, and then re-attempt the original method call. If successful, the original call site initiating the request will be unaffected by the interruption and simply see the original call as having succeeded.

See Authentication and Login for more details on this topic.

Note: for compatibility reasons with other platforms, this exception class does not follow the naming conventions of other classes of the Remoting SDK for Xcode framework, and omits the "RO" prefix. Please also note that for compatibility with old Delphi clients, this exception class also gets registered under the name "EROSessionNotFound"; thus, EROSessionNotFound exceptions raised on a Delphi server will be properly thrown as SessionNotFoundException on Xcode clients.

Location

 

exception

Creates and initializes SessionNotFoundException

+ (SessionNotFoundException *) exception

exceptionForRetry

Represent special exception that is raised during handling SessionNotFoundException jus after login attempt in order to re-run the failed asynchronous request again. In most cases you don't need to deal with it directly. All happens automatically behind the sciene.

+ (SessionNotFoundException *) exceptionForRetry

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

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.

retryingAsyncRequest

Boolean readonly flag shows should be failed asynchronous request restaeted after successfull login or not (YES by default).

@property (readonly) BOOL retryingAsyncRequest

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

retryingAsyncRequest

Boolean readonly flag shows should be failed asynchronous request restaeted after successfull login or not (YES by default).

@property (readonly) BOOL retryingAsyncRequest

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

 

exception

Creates and initializes SessionNotFoundException

+ (SessionNotFoundException *) exception

exceptionForRetry

Represent special exception that is raised during handling SessionNotFoundException jus after login attempt in order to re-run the failed asynchronous request again. In most cases you don't need to deal with it directly. All happens automatically behind the sciene.

+ (SessionNotFoundException *) exceptionForRetry

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

 

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.

See Also