ROTCPClientChannel

 

For internal use

Dispatches the given message asynchronously and returns an ROAsyncRequest reference.

This method relies on the internal method intAsyncDispatch:responseMessage: which implemenation depends on concrete client channel.

This method is deprecated. If you will need to dispatch some mesages manually, then please use asyncDispatch:withProxy:start or asyncDispatch:withProxy:startWithBlock: instead

- (ROAsyncRequest *) asyncDispatch:(id)aMessage

Parameters:

• aMessage: instance of ROMessage that need to be dispatched

---

For internal use

Prepares and return asynchronous request for dispatching the given message.

This method relies on the internal method intAsyncDispatch:responseMessage: which implemenation depends on concrete client channel.

This method is deprecated. If you will need to dispatch some mesages manually, then please use asyncDispatch:withProxy:start or asyncDispatch:withProxy:startWithBlock: instead

- (ROAsyncRequest *) asyncDispatch:(id)aMessage start:(BOOL)start

Parameters:

• aMessage: instance of ROMessage that need to be dispatched
• start: Boolean flag, If YES then it start dispatching request immediately. If NO, then request will start automatically. You will need to start it manually. Deffered starting asynchronous dispatching can be useful for additional configuring asynchronous request before running it.

---

For internal use

Prepares and return asynchronous request for dispatching the given message for given proxy.

This method relies on the internal method intAsyncDispatch:responseMessage: which implemenation depends on concrete client channel.

- (ROAsyncRequest *) asyncDispatch:(id)aMessage withProxy:(ROAsyncProxy *)proxy start:(BOOL)start

Parameters:

• aMessage: instance of ROMessage that need to be dispatched
• proxy: reference to the ROAsyncProxy which is stored in the result asynchronous request.

Later when asynchronous request completes, proxy can be used for obtaining request results. For example:

- (void) asyncRequestDidComplete:(ROAsyncRequest *)aRequest {
  ...
  if (aRequest.type == artGetDataTable) {
    NSData *data = [[request proxy] endGetData:aRequest];
    ...
  }
  ...
}

• start: Boolean flag, If YES then it start dispatching request immediately. If NO, then request will start automatically. You will need to start it manually. Deffered starting asynchronous dispatching can be useful for additional configuring asynchronous request before running it.

---

For internal use

Prepares and start asynchronous request with given completion block for dispatching the message for given proxy.

This method relies on the internal method intAsyncDispatch:responseMessage: which implemenation depends on concrete client channel.

- (ROAsyncRequest *) asyncDispatch:(id)aMessage withProxy:(ROAsyncProxy *)proxy startWithBlock:(void(^)(ROAsyncRequest *))block

Parameters:

• aMessage: instance of ROMessage that need to be dispatched
• proxy: reference to the ROAsyncProxy which is stored in the result asynchronous request.

Later when asynchronous request completes, proxy can be used for obtaining request results. For example:

- (void) asyncRequestDidComplete:(ROAsyncRequest *)aRequest {
  ...
  if (aRequest.type == artGetDataTable) {
    NSData *data = [[request proxy] endGetData:aRequest];
    ...
  }
  ...
}

• block: completion block, will be called after asynchronous dispatching ends

---

Returns a created channel

+ (id) channel

---

returns a new channel instance initialized with given NSURL

Deprecated. Please use channelWithTargetURL instead

+ (id) channelWithTargetUrl:(NSString *)targetUrl

Parameters:

• targetUrl: Target URL as String

---

returns a new channel instance initialized with given NSURL

+ (id) channelWithTargetURL:(NSURL *)targetUrl

Parameters:

• targetUrl: Target URL

---

- (void) checkProperties

---

+ (void) decreaseNetworkActivityIndicator

---

Delegate object to receive events through the ROClientChannelDelegate protocol.

@property (assign) id delegate

---

for internal use Dispatches the given message synchronously. This method relies on the intDispatch: method provided by concrete client channel implementations for the actual dispatching.

- (void) dispatch:(id)aMessage

Parameters:

• aMessage: instance of ROMessage that need to be dispatched

---

+ (void) handleAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge forHost:(NSString *)host callback:(BOOL(^)(ROCertificateInfo *))block

Parameters:

• challenge:
• host:
• block:

---

+ (void) increaseNetworkActivityIndicator

---

- (InstanceType) initWithHost:(NSString *)aHost port:(unsigned int)aPort

Parameters:

• aHost:
• aPort:

---

- (InstanceType) initWithTargetUrl:(NSString *)aTargetUrl

Parameters:

• aTargetUrl:

---

- (InstanceType) initWithTargetURL:(NSURL *)aTargetURL

Parameters:

• aTargetURL:

---

Property that shows is channel busy or not.

Actual implementation differs for different channels. For example syhchronous channels like HTTP channel can process only one request per moment. So using this property you can know does channel do something or its free for dispatching new messages.

@property (readonly) BOOL isBusy

---

- (void) performLoginNeeded:(ROServerException *)exception forAsyncRequest:(ROAsyncRequest *)request

Parameters:

• exception:
• request:

---

@property (readonly) NSRunLoop *runLoop

---

- (void) scheduleAsyncRequest:(ROAsyncRequest *)request

Parameters:

• request:

---

- (void) setTcpConnection:(ROTCPClientChannelConnection *)aConnection

Parameters:

• aConnection:

---

This property keeps target URL as the string, for the channel. Since any things with URL in String format are deprecated, please use targetURL property instead.

@property (copy, deprecated) NSString *targetUrl

---

Property keeps target URL, for the channel.

@property (copy) NSURL *targetURL

---

The maximum time for the client to wait for the server response. If the server response is not received or the number of bytes received is less than expected, a timeout exception occurs.

@property (assign) NSTimeInterval timeout

---

- (BOOL) triggerOnLoginNeeded:(ROServerException *)exception

Parameters:

• exception:

 

Delegate object to receive events through the ROClientChannelDelegate protocol.

@property (assign) id delegate

---

Property that shows is channel busy or not.

Actual implementation differs for different channels. For example syhchronous channels like HTTP channel can process only one request per moment. So using this property you can know does channel do something or its free for dispatching new messages.

@property (readonly) BOOL isBusy

---

@property (readonly) NSRunLoop *runLoop

---

This property keeps target URL as the string, for the channel. Since any things with URL in String format are deprecated, please use targetURL property instead.

@property (copy, deprecated) NSString *targetUrl

---

Property keeps target URL, for the channel.

@property (copy) NSURL *targetURL

---

The maximum time for the client to wait for the server response. If the server response is not received or the number of bytes received is less than expected, a timeout exception occurs.

@property (assign) NSTimeInterval timeout

 

Returns a created channel

+ (id) channel

---

returns a new channel instance initialized with given NSURL

Deprecated. Please use channelWithTargetURL instead

+ (id) channelWithTargetUrl:(NSString *)targetUrl

Parameters:

• targetUrl: Target URL as String

---

returns a new channel instance initialized with given NSURL

+ (id) channelWithTargetURL:(NSURL *)targetUrl

Parameters:

• targetUrl: Target URL

---

+ (void) decreaseNetworkActivityIndicator

---

+ (void) handleAuthenticationChallenge:(NSURLAuthenticationChallenge *)challenge forHost:(NSString *)host callback:(BOOL(^)(ROCertificateInfo *))block

Parameters:

• challenge:
• host:
• block:

---

+ (void) increaseNetworkActivityIndicator

 

For internal use

Dispatches the given message asynchronously and returns an ROAsyncRequest reference.

This method relies on the internal method intAsyncDispatch:responseMessage: which implemenation depends on concrete client channel.

This method is deprecated. If you will need to dispatch some mesages manually, then please use asyncDispatch:withProxy:start or asyncDispatch:withProxy:startWithBlock: instead

- (ROAsyncRequest *) asyncDispatch:(id)aMessage

Parameters:

• aMessage: instance of ROMessage that need to be dispatched

---

For internal use

Prepares and return asynchronous request for dispatching the given message.

This method relies on the internal method intAsyncDispatch:responseMessage: which implemenation depends on concrete client channel.

This method is deprecated. If you will need to dispatch some mesages manually, then please use asyncDispatch:withProxy:start or asyncDispatch:withProxy:startWithBlock: instead

- (ROAsyncRequest *) asyncDispatch:(id)aMessage start:(BOOL)start

Parameters:

• aMessage: instance of ROMessage that need to be dispatched
• start: Boolean flag, If YES then it start dispatching request immediately. If NO, then request will start automatically. You will need to start it manually. Deffered starting asynchronous dispatching can be useful for additional configuring asynchronous request before running it.

---

For internal use

Prepares and return asynchronous request for dispatching the given message for given proxy.

This method relies on the internal method intAsyncDispatch:responseMessage: which implemenation depends on concrete client channel.

- (ROAsyncRequest *) asyncDispatch:(id)aMessage withProxy:(ROAsyncProxy *)proxy start:(BOOL)start

Parameters:

• aMessage: instance of ROMessage that need to be dispatched
• proxy: reference to the ROAsyncProxy which is stored in the result asynchronous request.

Later when asynchronous request completes, proxy can be used for obtaining request results. For example:

- (void) asyncRequestDidComplete:(ROAsyncRequest *)aRequest {
  ...
  if (aRequest.type == artGetDataTable) {
    NSData *data = [[request proxy] endGetData:aRequest];
    ...
  }
  ...
}

• start: Boolean flag, If YES then it start dispatching request immediately. If NO, then request will start automatically. You will need to start it manually. Deffered starting asynchronous dispatching can be useful for additional configuring asynchronous request before running it.

---

For internal use

Prepares and start asynchronous request with given completion block for dispatching the message for given proxy.

This method relies on the internal method intAsyncDispatch:responseMessage: which implemenation depends on concrete client channel.

- (ROAsyncRequest *) asyncDispatch:(id)aMessage withProxy:(ROAsyncProxy *)proxy startWithBlock:(void(^)(ROAsyncRequest *))block

Parameters:

• aMessage: instance of ROMessage that need to be dispatched
• proxy: reference to the ROAsyncProxy which is stored in the result asynchronous request.

Later when asynchronous request completes, proxy can be used for obtaining request results. For example:

- (void) asyncRequestDidComplete:(ROAsyncRequest *)aRequest {
  ...
  if (aRequest.type == artGetDataTable) {
    NSData *data = [[request proxy] endGetData:aRequest];
    ...
  }
  ...
}

• block: completion block, will be called after asynchronous dispatching ends

---

- (void) checkProperties

---

for internal use Dispatches the given message synchronously. This method relies on the intDispatch: method provided by concrete client channel implementations for the actual dispatching.

- (void) dispatch:(id)aMessage

Parameters:

• aMessage: instance of ROMessage that need to be dispatched

---

- (InstanceType) initWithHost:(NSString *)aHost port:(unsigned int)aPort

Parameters:

• aHost:
• aPort:

---

- (InstanceType) initWithTargetUrl:(NSString *)aTargetUrl

Parameters:

• aTargetUrl:

---

- (InstanceType) initWithTargetURL:(NSURL *)aTargetURL

Parameters:

• aTargetURL:

---

- (void) performLoginNeeded:(ROServerException *)exception forAsyncRequest:(ROAsyncRequest *)request

Parameters:

• exception:
• request:

---

- (void) scheduleAsyncRequest:(ROAsyncRequest *)request

Parameters:

• request:

---

- (void) setTcpConnection:(ROTCPClientChannelConnection *)aConnection

Parameters:

• aConnection:

---

- (BOOL) triggerOnLoginNeeded:(ROServerException *)exception

Parameters:

• exception: