TROSCClientWorker

Overview

This is the super channel worker class designed to use on the client side.
This class is used internally, users will never intercat with it.

Location

 

Creates the worker instance.

constructor Create(aOwner: TROBaseSuperTCPChannel; ABaseSuperConnection: TROBaseSuperTcpConnection)

Parameters:

  • aOwner: The super channel instance that the worker works for.
  • ABaseSuperConnection: The connection object that worker will use for communication.

constructor Create (TROBaseSuperTcpConnection)    (declared in TROBaseSuperChannelWorker)

constructor Create(ABaseSuperConnection: TROBaseSuperTcpConnection)

Parameters:

  • ABaseSuperConnection:

BaseSuperConnection  protected    (declared in TROBaseSuperChannelWorker)

property BaseSuperConnection: TROBaseSuperTcpConnection read write

BeginWriteLock    (declared in TROBaseSuperChannelWorker)

procedure BeginWriteLock

ClientID    (declared in TROBaseSuperChannelWorker)

property ClientID: TGuid read write

Connected  protected override

procedure Connected

Disconnect    (declared in TROBaseSuperChannelWorker)

procedure Disconnect

Disconnected  protected override

procedure Disconnected(var RestartLoop: Boolean)

Parameters:

  • RestartLoop:

DoExecute    (declared in TROBaseSuperChannelWorker)

procedure DoExecute

EndWriteLock    (declared in TROBaseSuperChannelWorker)

procedure EndWriteLock

GenerateId    (declared in TROBaseSuperChannelWorker)

function GenerateId: Integer

GetDefaultResponse  protected virtual    (declared in TROBaseSuperChannelWorker)

function GetDefaultResponse: string

Idle  protected override

procedure Idle

IncomingData  protected override

procedure IncomingData(Id: Integer; aData: TStream)

Parameters:

  • Id:
  • aData:

IntSendData  protected    (declared in TROBaseSuperChannelWorker)

function IntSendData(Id: Integer; aData: TStream): IROPackageAck

Parameters:

  • Id:
  • aData:

IsConnected    (declared in TROBaseSuperChannelWorker)

property IsConnected: Boolean read write

IsServer  protected    (declared in TROBaseSuperChannelWorker)

property IsServer: Boolean read write

LastData  protected    (declared in TROBaseSuperChannelWorker)

property LastData: TDateTime read write

MaxPackageSize    (declared in TROBaseSuperChannelWorker)

property MaxPackageSize: Integer read write

OnProgress    (declared in TROBaseSuperChannelWorker)

property OnProgress: TProgressEvent read write
delegate: procedure OnProgress(iSender: TObject; iType: TProgressType; iDirection: TProgressDirection; iTransferred: integer; iTotal: integer)

Owner

Provides read-only access to the super channel instance that the worker works for.

property Owner: TROBaseSuperTCPChannel read write

PingFrequency  protected    (declared in TROBaseSuperChannelWorker)

property PingFrequency: Integer read write

PingTimeout  protected    (declared in TROBaseSuperChannelWorker)

property PingTimeout: Integer read write

ProcessOption  protected    (declared in TROBaseSuperChannelWorker)

procedure ProcessOption(Data: TStream)

Parameters:

  • Data:

ReadStream  protected    (declared in TROBaseSuperChannelWorker)

function ReadStream(aDest: TStream; aLen: Integer): Boolean

Parameters:

  • aDest:
  • aLen:

SendError    (declared in TROBaseSuperChannelWorker)

procedure SendError(Id: Integer; Error: Byte)

Parameters:

  • Id:
  • Error:

SendOptions  protected    (declared in TROBaseSuperChannelWorker)

procedure SendOptions(aData: ROUTF8String)

Parameters:

  • aData:

SendPackage    (declared in TROBaseSuperChannelWorker)

function SendPackage(aData: TStream; Id: Integer): IROPackageAck

Parameters:

  • aData:
  • Id:

SetAckDetails  protected override

procedure SetAckDetails(Id: Integer; Oke: Boolean; ErrorNo: Integer)

Parameters:

  • Id:
  • Oke:
  • ErrorNo:

SkipAck    (declared in TROBaseSuperChannelWorker)

property SkipAck: Boolean read write

SupportsOptions  protected    (declared in TROBaseSuperChannelWorker)

procedure SupportsOptions

WaitForAck    (declared in TROBaseSuperChannelWorker)

class procedure WaitForAck(pkg: IROPackageAck; Timeout: Integer)

Parameters:

  • pkg:
  • Timeout:

 

BaseSuperConnection  protected    (declared in TROBaseSuperChannelWorker)

property BaseSuperConnection: TROBaseSuperTcpConnection read write

ClientID    (declared in TROBaseSuperChannelWorker)

property ClientID: TGuid read write

IsConnected    (declared in TROBaseSuperChannelWorker)

property IsConnected: Boolean read write

IsServer  protected    (declared in TROBaseSuperChannelWorker)

property IsServer: Boolean read write

LastData  protected    (declared in TROBaseSuperChannelWorker)

property LastData: TDateTime read write

MaxPackageSize    (declared in TROBaseSuperChannelWorker)

property MaxPackageSize: Integer read write

Owner

Provides read-only access to the super channel instance that the worker works for.

property Owner: TROBaseSuperTCPChannel read write

PingFrequency  protected    (declared in TROBaseSuperChannelWorker)

property PingFrequency: Integer read write

PingTimeout  protected    (declared in TROBaseSuperChannelWorker)

property PingTimeout: Integer read write

SkipAck    (declared in TROBaseSuperChannelWorker)

property SkipAck: Boolean read write

 

WaitForAck    (declared in TROBaseSuperChannelWorker)

class procedure WaitForAck(pkg: IROPackageAck; Timeout: Integer)

Parameters:

  • pkg:
  • Timeout:

 

Creates the worker instance.

constructor Create(aOwner: TROBaseSuperTCPChannel; ABaseSuperConnection: TROBaseSuperTcpConnection)

Parameters:

  • aOwner: The super channel instance that the worker works for.
  • ABaseSuperConnection: The connection object that worker will use for communication.

constructor Create (TROBaseSuperTcpConnection)    (declared in TROBaseSuperChannelWorker)

constructor Create(ABaseSuperConnection: TROBaseSuperTcpConnection)

Parameters:

  • ABaseSuperConnection:

BeginWriteLock    (declared in TROBaseSuperChannelWorker)

procedure BeginWriteLock

Connected  protected override

procedure Connected

Disconnect    (declared in TROBaseSuperChannelWorker)

procedure Disconnect

Disconnected  protected override

procedure Disconnected(var RestartLoop: Boolean)

Parameters:

  • RestartLoop:

DoExecute    (declared in TROBaseSuperChannelWorker)

procedure DoExecute

EndWriteLock    (declared in TROBaseSuperChannelWorker)

procedure EndWriteLock

GenerateId    (declared in TROBaseSuperChannelWorker)

function GenerateId: Integer

GetDefaultResponse  protected virtual    (declared in TROBaseSuperChannelWorker)

function GetDefaultResponse: string

Idle  protected override

procedure Idle

IncomingData  protected override

procedure IncomingData(Id: Integer; aData: TStream)

Parameters:

  • Id:
  • aData:

IntSendData  protected    (declared in TROBaseSuperChannelWorker)

function IntSendData(Id: Integer; aData: TStream): IROPackageAck

Parameters:

  • Id:
  • aData:

ProcessOption  protected    (declared in TROBaseSuperChannelWorker)

procedure ProcessOption(Data: TStream)

Parameters:

  • Data:

ReadStream  protected    (declared in TROBaseSuperChannelWorker)

function ReadStream(aDest: TStream; aLen: Integer): Boolean

Parameters:

  • aDest:
  • aLen:

SendError    (declared in TROBaseSuperChannelWorker)

procedure SendError(Id: Integer; Error: Byte)

Parameters:

  • Id:
  • Error:

SendOptions  protected    (declared in TROBaseSuperChannelWorker)

procedure SendOptions(aData: ROUTF8String)

Parameters:

  • aData:

SendPackage    (declared in TROBaseSuperChannelWorker)

function SendPackage(aData: TStream; Id: Integer): IROPackageAck

Parameters:

  • aData:
  • Id:

SetAckDetails  protected override

procedure SetAckDetails(Id: Integer; Oke: Boolean; ErrorNo: Integer)

Parameters:

  • Id:
  • Oke:
  • ErrorNo:

SupportsOptions  protected    (declared in TROBaseSuperChannelWorker)

procedure SupportsOptions

 

OnProgress    (declared in TROBaseSuperChannelWorker)

property OnProgress: TProgressEvent read write
delegate: procedure OnProgress(iSender: TObject; iType: TProgressType; iDirection: TProgressDirection; iTransferred: integer; iTotal: integer)