HttpClientChannel

Overview

HttpClientChannel implements the standard Client Channels for communicating with Remoting SDK servers via the HTTP protocol.

Location

 

constructor

Creates HttpClientChannel.

 

constructor

 

HttpClientChannel()

constructor (URI)    (declared in ClientChannel)

Creates ClientChannel with given URI.

 

constructor(targetUri: URI)

 

HttpClientChannel(URI targetUri)

Parameters:

  • targetUri: Given URI.

constructor (URI)

Creates HttpClientChannel with given TargetUri.

 

constructor(targetUrl: URI)

 

HttpClientChannel(URI targetUrl)

Parameters:

  • targetUrl: TargetUri

asyncDispatch    (declared in ClientChannel)

Dispatches the given message asynchronously and returns an AsyncRequest object. Mainly for internal use.

 

method asyncDispatch(message: Message; proxy: AsyncProxy; start: Boolean; callback: IAsyncRequestCallback): AsyncRequest

 

AsyncRequest asyncDispatch(Message message, AsyncProxy proxy, Boolean start, IAsyncRequestCallback callback)

Parameters:

  • message: Given message.
  • proxy: Given proxy.
  • start: Given start.
  • callback: Given callback.

Authorization

Authorization

 

property Authorization: String read write;

 

String Authorization { __get; __set; }

channelWithURI    (declared in ClientChannel)

Returns ClientChannel object created via URL Schemes

 

class method channelWithURI(uri: URI): ClientChannel

 

static ClientChannel channelWithURI(URI uri)

Parameters:

  • uri: Given URI.

ConnectTimeout

Timeout in milliseconds after which this HttpClientChannel will abort trying to connect to the server. This ensures that for unresponsive servers, the client will not hang indefinitely trying to establish a connection to the server.

The default value is 30000 (i.e. 30 seconds).

 

property ConnectTimeout: Integer read write;

 

Integer ConnectTimeout { __get; __set; }

dispatch    (declared in ClientChannel)

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

 

method dispatch(message: Message)

 

void dispatch(Message message)

Parameters:

  • message: Given message.

FollowRedirects

Follow redirects

 

property FollowRedirects: Boolean read write;

 

Boolean FollowRedirects { __get; __set; }

isCallbackHolder    (declared in ClientChannel)

 

method isCallbackHolder: Boolean

 

Boolean isCallbackHolder()

ReadTimeout

The timeout, in milliseconds, after which the client channel will abort the request. This ensures that for unresponsive servers, the client will not hang indefinitely waiting for a reply.

The default value is 30000 (i.e. 30 seconds).

 

property ReadTimeout: Integer read write;

 

Integer ReadTimeout { __get; __set; }

setChannelCallback    (declared in ClientChannel)

Sets callback.

 

method setChannelCallback(callback: IClientChannelCallback)

 

void setChannelCallback(IClientChannelCallback callback)

Parameters:

  • callback: Given callback.

setupHttpRequest  protected

 

method setupHttpRequest(request: HttpURLConnection)

 

void setupHttpRequest(HttpURLConnection request)

Parameters:

  • request:

TargetUrl    (declared in ClientChannel)

TargetUrl

 

property TargetUrl: URI read write;

 

URI TargetUrl { __get; __set; }

Timeout

Specified the timeout, in milliseconds, after which the client channel will abort the request. Default value is 30000 (i.e. 30 seconds)

 

property Timeout: Integer read write;

 

Integer Timeout { __get; __set; }

triggerOnLoginNeeded  protected    (declared in ClientChannel)

 

method triggerOnLoginNeeded(message: Message; exception: Exception): Boolean

 

Boolean triggerOnLoginNeeded(Message message, Exception exception)

Parameters:

  • message:
  • exception:

 

Authorization

Authorization

 

property Authorization: String read write;

 

String Authorization { __get; __set; }

ConnectTimeout

Timeout in milliseconds after which this HttpClientChannel will abort trying to connect to the server. This ensures that for unresponsive servers, the client will not hang indefinitely trying to establish a connection to the server.

The default value is 30000 (i.e. 30 seconds).

 

property ConnectTimeout: Integer read write;

 

Integer ConnectTimeout { __get; __set; }

FollowRedirects

Follow redirects

 

property FollowRedirects: Boolean read write;

 

Boolean FollowRedirects { __get; __set; }

ReadTimeout

The timeout, in milliseconds, after which the client channel will abort the request. This ensures that for unresponsive servers, the client will not hang indefinitely waiting for a reply.

The default value is 30000 (i.e. 30 seconds).

 

property ReadTimeout: Integer read write;

 

Integer ReadTimeout { __get; __set; }

TargetUrl    (declared in ClientChannel)

TargetUrl

 

property TargetUrl: URI read write;

 

URI TargetUrl { __get; __set; }

Timeout

Specified the timeout, in milliseconds, after which the client channel will abort the request. Default value is 30000 (i.e. 30 seconds)

 

property Timeout: Integer read write;

 

Integer Timeout { __get; __set; }

 

channelWithURI    (declared in ClientChannel)

Returns ClientChannel object created via URL Schemes

 

class method channelWithURI(uri: URI): ClientChannel

 

static ClientChannel channelWithURI(URI uri)

Parameters:

  • uri: Given URI.

 

constructor

Creates HttpClientChannel.

 

constructor

 

HttpClientChannel()

constructor (URI)    (declared in ClientChannel)

Creates ClientChannel with given URI.

 

constructor(targetUri: URI)

 

HttpClientChannel(URI targetUri)

Parameters:

  • targetUri: Given URI.

constructor (URI)

Creates HttpClientChannel with given TargetUri.

 

constructor(targetUrl: URI)

 

HttpClientChannel(URI targetUrl)

Parameters:

  • targetUrl: TargetUri

asyncDispatch    (declared in ClientChannel)

Dispatches the given message asynchronously and returns an AsyncRequest object. Mainly for internal use.

 

method asyncDispatch(message: Message; proxy: AsyncProxy; start: Boolean; callback: IAsyncRequestCallback): AsyncRequest

 

AsyncRequest asyncDispatch(Message message, AsyncProxy proxy, Boolean start, IAsyncRequestCallback callback)

Parameters:

  • message: Given message.
  • proxy: Given proxy.
  • start: Given start.
  • callback: Given callback.

dispatch    (declared in ClientChannel)

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

 

method dispatch(message: Message)

 

void dispatch(Message message)

Parameters:

  • message: Given message.

isCallbackHolder    (declared in ClientChannel)

 

method isCallbackHolder: Boolean

 

Boolean isCallbackHolder()

setChannelCallback    (declared in ClientChannel)

Sets callback.

 

method setChannelCallback(callback: IClientChannelCallback)

 

void setChannelCallback(IClientChannelCallback callback)

Parameters:

  • callback: Given callback.

setupHttpRequest  protected

 

method setupHttpRequest(request: HttpURLConnection)

 

void setupHttpRequest(HttpURLConnection request)

Parameters:

  • request:

triggerOnLoginNeeded  protected    (declared in ClientChannel)

 

method triggerOnLoginNeeded(message: Message; exception: Exception): Boolean

 

Boolean triggerOnLoginNeeded(Message message, Exception exception)

Parameters:

  • message:
  • exception: