ROAsyncRequestDelegate

Overview

The ROAsyncRequestDelegate describes the delegate methods that a ROAsyncRequest will call on its delegate object, to inform it about progress, success or failure of the request.

Location

 

asyncRequest:didFailWithException:

Informs the delegate that the request has failed with the given exception. This can happen either if the request failed on the network level and never received a response, or if an exception, raised while executing asyncRequestDidComplete:, was not caught.

- (void) asyncRequest:(ROAsyncRequest *)request didFailWithException:(NSException *)exception

Parameters:

  • request: Reference to failed async request
  • exception: Reference to exception that was raised.

asyncRequest:didReceiveDataSize:ofExpected:

Informs the delegate that the request is in progress and has received the amount of bytes indicated by size and that a total of totalSize bytes is expected. This delegate method is useful for displaying progress information to the user, or otherwise keeping track of a large download of data.

@optional - (void) asyncRequest:(ROAsyncRequest *)request didReceiveDataSize:(int)size ofExpected:(int)totalSize

Parameters:

  • request: Reference to async request which recieves the data
  • size: recieved amount of bytes
  • totalSize: expected ammoun t of bytes

asyncRequest:shouldAcceptUntrustedServerCertificate:

Informs the delegate that the request has to deside should it accept or not untrusted sertificate to connect to the protected service for completing his job

@optional - (BOOL) asyncRequest:(ROAsyncRequest *)request shouldAcceptUntrustedServerCertificate:(ROCertificateInfo *)cert

Parameters:

  • request: reference to async request
  • cert: referense to the certificate info

asyncRequestDidComplete:

Informs the delegate that the request has completed successfully, and the end* method can now be called to obtain its result, if any. The done property will be set to YES before this message is sent.

Note: Receiving this message does not necessarily imply that the request has completed successfully' on the server. Any excpetion returned from the server will not be thrown until theend*` method is called.

- (void) asyncRequestDidComplete:(ROAsyncRequest *)request

Parameters:

  • request: Reference to completed async request

asyncRequestDidFinishLogin:   deprecated

Informs the delegate that the request did finish login operation to the server.

@optional - (void) asyncRequestDidFinishLogin:(ROAsyncRequest *)request

Parameters:

  • request: Reference to async request which did finish login operation

asyncRequestNeedsLogin:   deprecated

Informs the delegate that the request has failed with a SessionNotFoundException and login is required to complete the request. The client should call the server's (user-defined) Login method or perform whatever other action is necessary to authenticate, and then return YES if the request should be resent, or NO if authentication was not successful and the request should be aborted.

@optional - (BOOL) asyncRequestNeedsLogin:(ROAsyncRequest *)request

Parameters:

  • request: Reference to the async request which need to login to the server in order to complete his job

asyncRequestWasCanceled:

Informs the delegate that the request has been canceled by user.

@optional - (void) asyncRequestWasCanceled:(ROAsyncRequest *)request

Parameters:

  • request: Reference to canceled async request

asyncRequestWasSuspendedAwaitingLogin:

Informs the delegate that the request has been suspended due to the need to login to the server. After successful login, request will be restarted automatically

@optional - (void) asyncRequestWasSuspendedAwaitingLogin:(ROAsyncRequest *)request

Parameters:

  • request: Reference to suspended async request

asyncRequestWillBeginLogin:   deprecated

Informs the delegate that the request is going to start login operation to the server.

@optional - (void) asyncRequestWillBeginLogin:(ROAsyncRequest *)request

Parameters:

  • request: Reference to async request which is going to start login operation

 

asyncRequest:didFailWithException:

Informs the delegate that the request has failed with the given exception. This can happen either if the request failed on the network level and never received a response, or if an exception, raised while executing asyncRequestDidComplete:, was not caught.

- (void) asyncRequest:(ROAsyncRequest *)request didFailWithException:(NSException *)exception

Parameters:

  • request: Reference to failed async request
  • exception: Reference to exception that was raised.

asyncRequestDidComplete:

Informs the delegate that the request has completed successfully, and the end* method can now be called to obtain its result, if any. The done property will be set to YES before this message is sent.

Note: Receiving this message does not necessarily imply that the request has completed successfully' on the server. Any excpetion returned from the server will not be thrown until theend*` method is called.

- (void) asyncRequestDidComplete:(ROAsyncRequest *)request

Parameters:

  • request: Reference to completed async request

 

asyncRequest:didReceiveDataSize:ofExpected:

Informs the delegate that the request is in progress and has received the amount of bytes indicated by size and that a total of totalSize bytes is expected. This delegate method is useful for displaying progress information to the user, or otherwise keeping track of a large download of data.

@optional - (void) asyncRequest:(ROAsyncRequest *)request didReceiveDataSize:(int)size ofExpected:(int)totalSize

Parameters:

  • request: Reference to async request which recieves the data
  • size: recieved amount of bytes
  • totalSize: expected ammoun t of bytes

asyncRequest:shouldAcceptUntrustedServerCertificate:

Informs the delegate that the request has to deside should it accept or not untrusted sertificate to connect to the protected service for completing his job

@optional - (BOOL) asyncRequest:(ROAsyncRequest *)request shouldAcceptUntrustedServerCertificate:(ROCertificateInfo *)cert

Parameters:

  • request: reference to async request
  • cert: referense to the certificate info

asyncRequestDidFinishLogin:   deprecated

Informs the delegate that the request did finish login operation to the server.

@optional - (void) asyncRequestDidFinishLogin:(ROAsyncRequest *)request

Parameters:

  • request: Reference to async request which did finish login operation

asyncRequestNeedsLogin:   deprecated

Informs the delegate that the request has failed with a SessionNotFoundException and login is required to complete the request. The client should call the server's (user-defined) Login method or perform whatever other action is necessary to authenticate, and then return YES if the request should be resent, or NO if authentication was not successful and the request should be aborted.

@optional - (BOOL) asyncRequestNeedsLogin:(ROAsyncRequest *)request

Parameters:

  • request: Reference to the async request which need to login to the server in order to complete his job

asyncRequestWasCanceled:

Informs the delegate that the request has been canceled by user.

@optional - (void) asyncRequestWasCanceled:(ROAsyncRequest *)request

Parameters:

  • request: Reference to canceled async request

asyncRequestWasSuspendedAwaitingLogin:

Informs the delegate that the request has been suspended due to the need to login to the server. After successful login, request will be restarted automatically

@optional - (void) asyncRequestWasSuspendedAwaitingLogin:(ROAsyncRequest *)request

Parameters:

  • request: Reference to suspended async request

asyncRequestWillBeginLogin:   deprecated

Informs the delegate that the request is going to start login operation to the server.

@optional - (void) asyncRequestWillBeginLogin:(ROAsyncRequest *)request

Parameters:

  • request: Reference to async request which is going to start login operation