SuperHttpClientChannelWorker
Overview
Location
- Reference: RemObjects.SDK.dll
- Namespace: RemObjects.SDK
constructor protected
constructor
SuperHttpClientChannelWorker()
Sub New()
Activate
method Activate(targetUrl: String; clientId: Guid)
void Activate(String targetUrl, Guid clientId)
Sub Activate(targetUrl As String, clientId As Guid)
Parameters:
- targetUrl:
- clientId:
CancelRequest protected
method CancelRequest(waitingThread: Boolean)
void CancelRequest(Boolean waitingThread)
Sub CancelRequest(waitingThread As Boolean)
Parameters:
- waitingThread:
ConnectTimeout
The timeout, in milliseconds, after which the worker will abort trying to connect to the server. This ensures that for unresponsive servers, the client will not hang indefinitely when trying to connect.
The default value is 10000 (i.e. 10 seconds).
property ConnectTimeout: Int32 read write;
Int32 ConnectTimeout { get; set; }
Property ConnectTimeout() As Int32
Deactivate
method Deactivate
void Deactivate()
Sub Deactivate()
DispatchMessage
method DispatchMessage(request: Stream; response: IMessage)
void DispatchMessage(Stream request, IMessage response)
Sub DispatchMessage(request As Stream, response As IMessage)
Parameters:
- request:
- response:
DispatchRequest protected
method DispatchRequest(waitingThread: Boolean; request: array of Byte; timeout: Int32): array of Byte
Byte[] DispatchRequest(Boolean waitingThread, Byte[] request, Int32 timeout)
Function DispatchRequest(waitingThread As Boolean, request As Byte(), timeout As Int32) As Byte()
Parameters:
- waitingThread:
- request:
- timeout:
EventThreadPool
property EventThreadPool: IThreadPool read write;
IThreadPool EventThreadPool { get; set; }
Property EventThreadPool() As IThreadPool
HttpTimeout
The timeout, in milliseconds, after which the worker will abort the request. This ensures that for unresponsive servers, the client will not hang indefinitely waiting for a reply.
The default value is 10000 (i.e. 10 seconds).
property HttpTimeout: Int32 read write;
Int32 HttpTimeout { get; set; }
Property HttpTimeout() As Int32
IsConnected
property IsConnected: Boolean read;
Boolean IsConnected { get; }
ReadOnly Property IsConnected() As Boolean
MaxPackageSize
property MaxPackageSize: Int32 read write;
Int32 MaxPackageSize { get; set; }
Property MaxPackageSize() As Int32
RegisterEventReceiver
method RegisterEventReceiver(receiver: IEventReceiver)
void RegisterEventReceiver(IEventReceiver receiver)
Sub RegisterEventReceiver(receiver As IEventReceiver)
Parameters:
- receiver:
RequestTimeout
The timeout, in milliseconds, after which the worker will abort the request. This ensures that for unresponsive servers, the client will not hang indefinitely waiting for a reply.
The default value is 60000 (i.e. 1 minute).
property RequestTimeout: Int32 read write;
Int32 RequestTimeout { get; set; }
Property RequestTimeout() As Int32
ResetConnection protected
method ResetConnection(waitingThread: Boolean)
void ResetConnection(Boolean waitingThread)
Sub ResetConnection(waitingThread As Boolean)
Parameters:
- waitingThread:
RetrieveRodl
method RetrieveRodl(targetUrl: String; connectionId: Guid): RodlLibrary
RodlLibrary RetrieveRodl(String targetUrl, Guid connectionId)
Function RetrieveRodl(targetUrl As String, connectionId As Guid) As RodlLibrary
Parameters:
- targetUrl:
- connectionId:
TargetUrl protected
property TargetUrl: String read;
String TargetUrl { get; }
ReadOnly Property TargetUrl() As String
UnregisterEventReceiver
method UnregisterEventReceiver(receiver: IEventReceiver)
void UnregisterEventReceiver(IEventReceiver receiver)
Sub UnregisterEventReceiver(receiver As IEventReceiver)
Parameters:
- receiver:
UseEventThreadPool
property UseEventThreadPool: Boolean read write;
Boolean UseEventThreadPool { get; set; }
Property UseEventThreadPool() As Boolean
UserAgent
property UserAgent: String read write;
String UserAgent { get; set; }
Property UserAgent() As String
WaitConnected
method WaitConnected(throwOnError: Boolean)
void WaitConnected(Boolean throwOnError)
Sub WaitConnected(throwOnError As Boolean)
Parameters:
- throwOnError:
ConnectTimeout
The timeout, in milliseconds, after which the worker will abort trying to connect to the server. This ensures that for unresponsive servers, the client will not hang indefinitely when trying to connect.
The default value is 10000 (i.e. 10 seconds).
property ConnectTimeout: Int32 read write;
Int32 ConnectTimeout { get; set; }
Property ConnectTimeout() As Int32
EventThreadPool
property EventThreadPool: IThreadPool read write;
IThreadPool EventThreadPool { get; set; }
Property EventThreadPool() As IThreadPool
HttpTimeout
The timeout, in milliseconds, after which the worker will abort the request. This ensures that for unresponsive servers, the client will not hang indefinitely waiting for a reply.
The default value is 10000 (i.e. 10 seconds).
property HttpTimeout: Int32 read write;
Int32 HttpTimeout { get; set; }
Property HttpTimeout() As Int32
IsConnected
property IsConnected: Boolean read;
Boolean IsConnected { get; }
ReadOnly Property IsConnected() As Boolean
MaxPackageSize
property MaxPackageSize: Int32 read write;
Int32 MaxPackageSize { get; set; }
Property MaxPackageSize() As Int32
RequestTimeout
The timeout, in milliseconds, after which the worker will abort the request. This ensures that for unresponsive servers, the client will not hang indefinitely waiting for a reply.
The default value is 60000 (i.e. 1 minute).
property RequestTimeout: Int32 read write;
Int32 RequestTimeout { get; set; }
Property RequestTimeout() As Int32
TargetUrl protected
property TargetUrl: String read;
String TargetUrl { get; }
ReadOnly Property TargetUrl() As String
UseEventThreadPool
property UseEventThreadPool: Boolean read write;
Boolean UseEventThreadPool { get; set; }
Property UseEventThreadPool() As Boolean
UserAgent
property UserAgent: String read write;
String UserAgent { get; set; }
Property UserAgent() As String
constructor protected
constructor
SuperHttpClientChannelWorker()
Sub New()
Activate
method Activate(targetUrl: String; clientId: Guid)
void Activate(String targetUrl, Guid clientId)
Sub Activate(targetUrl As String, clientId As Guid)
Parameters:
- targetUrl:
- clientId:
CancelRequest protected
method CancelRequest(waitingThread: Boolean)
void CancelRequest(Boolean waitingThread)
Sub CancelRequest(waitingThread As Boolean)
Parameters:
- waitingThread:
Deactivate
method Deactivate
void Deactivate()
Sub Deactivate()
DispatchMessage
method DispatchMessage(request: Stream; response: IMessage)
void DispatchMessage(Stream request, IMessage response)
Sub DispatchMessage(request As Stream, response As IMessage)
Parameters:
- request:
- response:
DispatchRequest protected
method DispatchRequest(waitingThread: Boolean; request: array of Byte; timeout: Int32): array of Byte
Byte[] DispatchRequest(Boolean waitingThread, Byte[] request, Int32 timeout)
Function DispatchRequest(waitingThread As Boolean, request As Byte(), timeout As Int32) As Byte()
Parameters:
- waitingThread:
- request:
- timeout:
RegisterEventReceiver
method RegisterEventReceiver(receiver: IEventReceiver)
void RegisterEventReceiver(IEventReceiver receiver)
Sub RegisterEventReceiver(receiver As IEventReceiver)
Parameters:
- receiver:
ResetConnection protected
method ResetConnection(waitingThread: Boolean)
void ResetConnection(Boolean waitingThread)
Sub ResetConnection(waitingThread As Boolean)
Parameters:
- waitingThread:
RetrieveRodl
method RetrieveRodl(targetUrl: String; connectionId: Guid): RodlLibrary
RodlLibrary RetrieveRodl(String targetUrl, Guid connectionId)
Function RetrieveRodl(targetUrl As String, connectionId As Guid) As RodlLibrary
Parameters:
- targetUrl:
- connectionId:
UnregisterEventReceiver
method UnregisterEventReceiver(receiver: IEventReceiver)
void UnregisterEventReceiver(IEventReceiver receiver)
Sub UnregisterEventReceiver(receiver As IEventReceiver)
Parameters:
- receiver:
WaitConnected
method WaitConnected(throwOnError: Boolean)
void WaitConnected(Boolean throwOnError)
Sub WaitConnected(throwOnError As Boolean)
Parameters:
- throwOnError: