SuperHttpClientChannelWorker

Overview

Location


 

constructor  protected

 

constructor

 

SuperHttpClientChannelWorker()

 

init()

 

Sub New()

Activate

 

method Activate(targetUrl: String; clientId: Guid)

 

void Activate(String targetUrl, Guid clientId)

 

func Activate(_ targetUrl: String, _ clientId: Guid)

 

Sub Activate(targetUrl As String, clientId As Guid)

Parameters:

  • targetUrl:
  • clientId:

CancelRequest  protected

 

method CancelRequest(waitingThread: Boolean)

 

void CancelRequest(Boolean waitingThread)

 

func CancelRequest(_ waitingThread: Boolean)

 

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; }

 

var ConnectTimeout: Int32 { get{} set{} }

 

Property ConnectTimeout() As Int32

Deactivate

 

method Deactivate

 

void Deactivate()

 

func Deactivate()

 

Sub Deactivate()

DispatchMessage

 

method DispatchMessage(request: Stream; response: IMessage)

 

void DispatchMessage(Stream request, IMessage response)

 

func DispatchMessage(_ request: Stream, _ response: IMessage)

 

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)

 

func DispatchRequest(_ waitingThread: Boolean, _ request: Byte..., _ timeout: Int32) -> Byte...

 

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; }

 

var EventThreadPool: IThreadPool { 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; }

 

var HttpTimeout: Int32 { get{} set{} }

 

Property HttpTimeout() As Int32

IsConnected

 

property IsConnected: Boolean read;

 

Boolean IsConnected { get; }

 

var IsConnected: Boolean { get{} }

 

ReadOnly Property IsConnected() As Boolean

MaxPackageSize

The maximum size of data package that the channel can send or receive.

 

property MaxPackageSize: Int32 read write;

 

Int32 MaxPackageSize { get; set; }

 

var MaxPackageSize: Int32 { get{} set{} }

 

Property MaxPackageSize() As Int32

RegisterEventReceiver

 

method RegisterEventReceiver(receiver: IEventReceiver)

 

void RegisterEventReceiver(IEventReceiver receiver)

 

func RegisterEventReceiver(_ receiver: IEventReceiver)

 

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; }

 

var RequestTimeout: Int32 { get{} set{} }

 

Property RequestTimeout() As Int32

ResetConnection  protected

 

method ResetConnection(waitingThread: Boolean)

 

void ResetConnection(Boolean waitingThread)

 

func ResetConnection(_ waitingThread: Boolean)

 

Sub ResetConnection(waitingThread As Boolean)

Parameters:

  • waitingThread:

RetrieveRodl

 

method RetrieveRodl(targetUrl: String; connectionId: Guid): RodlLibrary

 

RodlLibrary RetrieveRodl(String targetUrl, Guid connectionId)

 

func RetrieveRodl(_ targetUrl: String, _ connectionId: Guid) -> RodlLibrary

 

Function RetrieveRodl(targetUrl As String, connectionId As Guid) As RodlLibrary

Parameters:

  • targetUrl:
  • connectionId:

TargetUrl  protected

 

property TargetUrl: String read;

 

String TargetUrl { get; }

 

var TargetUrl: String { get{} }

 

ReadOnly Property TargetUrl() As String

UnregisterEventReceiver

 

method UnregisterEventReceiver(receiver: IEventReceiver)

 

void UnregisterEventReceiver(IEventReceiver receiver)

 

func UnregisterEventReceiver(_ receiver: IEventReceiver)

 

Sub UnregisterEventReceiver(receiver As IEventReceiver)

Parameters:

  • receiver:

UseEventThreadPool

 

property UseEventThreadPool: Boolean read write;

 

Boolean UseEventThreadPool { get; set; }

 

var UseEventThreadPool: Boolean { get{} set{} }

 

Property UseEventThreadPool() As Boolean

UserAgent

 

property UserAgent: String read write;

 

String UserAgent { get; set; }

 

var UserAgent: String { get{} set{} }

 

Property UserAgent() As String

WaitConnected

 

method WaitConnected(throwOnError: Boolean)

 

void WaitConnected(Boolean throwOnError)

 

func WaitConnected(_ throwOnError: Boolean)

 

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; }

 

var ConnectTimeout: Int32 { get{} set{} }

 

Property ConnectTimeout() As Int32

EventThreadPool

 

property EventThreadPool: IThreadPool read write;

 

IThreadPool EventThreadPool { get; set; }

 

var EventThreadPool: IThreadPool { 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; }

 

var HttpTimeout: Int32 { get{} set{} }

 

Property HttpTimeout() As Int32

IsConnected

 

property IsConnected: Boolean read;

 

Boolean IsConnected { get; }

 

var IsConnected: Boolean { get{} }

 

ReadOnly Property IsConnected() As Boolean

MaxPackageSize

The maximum size of data package that the channel can send or receive.

 

property MaxPackageSize: Int32 read write;

 

Int32 MaxPackageSize { get; set; }

 

var MaxPackageSize: Int32 { 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; }

 

var RequestTimeout: Int32 { get{} set{} }

 

Property RequestTimeout() As Int32

TargetUrl  protected

 

property TargetUrl: String read;

 

String TargetUrl { get; }

 

var TargetUrl: String { get{} }

 

ReadOnly Property TargetUrl() As String

UseEventThreadPool

 

property UseEventThreadPool: Boolean read write;

 

Boolean UseEventThreadPool { get; set; }

 

var UseEventThreadPool: Boolean { get{} set{} }

 

Property UseEventThreadPool() As Boolean

UserAgent

 

property UserAgent: String read write;

 

String UserAgent { get; set; }

 

var UserAgent: String { get{} set{} }

 

Property UserAgent() As String

 

constructor  protected

 

constructor

 

SuperHttpClientChannelWorker()

 

init()

 

Sub New()

Activate

 

method Activate(targetUrl: String; clientId: Guid)

 

void Activate(String targetUrl, Guid clientId)

 

func Activate(_ targetUrl: String, _ clientId: Guid)

 

Sub Activate(targetUrl As String, clientId As Guid)

Parameters:

  • targetUrl:
  • clientId:

CancelRequest  protected

 

method CancelRequest(waitingThread: Boolean)

 

void CancelRequest(Boolean waitingThread)

 

func CancelRequest(_ waitingThread: Boolean)

 

Sub CancelRequest(waitingThread As Boolean)

Parameters:

  • waitingThread:

Deactivate

 

method Deactivate

 

void Deactivate()

 

func Deactivate()

 

Sub Deactivate()

DispatchMessage

 

method DispatchMessage(request: Stream; response: IMessage)

 

void DispatchMessage(Stream request, IMessage response)

 

func DispatchMessage(_ request: Stream, _ response: IMessage)

 

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)

 

func DispatchRequest(_ waitingThread: Boolean, _ request: Byte..., _ timeout: Int32) -> Byte...

 

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)

 

func RegisterEventReceiver(_ receiver: IEventReceiver)

 

Sub RegisterEventReceiver(receiver As IEventReceiver)

Parameters:

  • receiver:

ResetConnection  protected

 

method ResetConnection(waitingThread: Boolean)

 

void ResetConnection(Boolean waitingThread)

 

func ResetConnection(_ waitingThread: Boolean)

 

Sub ResetConnection(waitingThread As Boolean)

Parameters:

  • waitingThread:

RetrieveRodl

 

method RetrieveRodl(targetUrl: String; connectionId: Guid): RodlLibrary

 

RodlLibrary RetrieveRodl(String targetUrl, Guid connectionId)

 

func RetrieveRodl(_ targetUrl: String, _ connectionId: Guid) -> RodlLibrary

 

Function RetrieveRodl(targetUrl As String, connectionId As Guid) As RodlLibrary

Parameters:

  • targetUrl:
  • connectionId:

UnregisterEventReceiver

 

method UnregisterEventReceiver(receiver: IEventReceiver)

 

void UnregisterEventReceiver(IEventReceiver receiver)

 

func UnregisterEventReceiver(_ receiver: IEventReceiver)

 

Sub UnregisterEventReceiver(receiver As IEventReceiver)

Parameters:

  • receiver:

WaitConnected

 

method WaitConnected(throwOnError: Boolean)

 

void WaitConnected(Boolean throwOnError)

 

func WaitConnected(_ throwOnError: Boolean)

 

Sub WaitConnected(throwOnError As Boolean)

Parameters:

  • throwOnError: